Software Documentation
Probably best to maintain documentation as web pages vs. Knowledge base articles. There's a mechanism for publishing KBase articles, but it's quirky, and the KBase article editor isn't nearly as rich as the web page editor. -Loren
⭐ Release Notes
Explain in a single sentence what has been changed.
🔗 Links
List here all the material and documentation related to the task.
📝 Purpose
Explain in a few words the problem that this change is going to solve.
🧠 Functional Specifications
List here all the changes to implement.
- Change 1
- Change 2
- Change 3
⚙ Technical Specifications
Ask a Senior Engineer to fill this part before launching the task.
| Change | Complexity |
| Change 1 | |
| Change 2 | |
| Change 3 | |
Extra Technical Instructions:
❓ Open Questions
Lay here any remaining question or doubt.
Q1: Would it be possible to...
Q2: Would there be an issue if...
🔍 Review Checklist
Ask the developer to go through this checklist before asking for a review.
- I made sure any visual change is responsive
- I made sure it did not introduce any obvious regression
- I made sure it did not introduce any security flaw