mirror of
https://github.com/kamranahmedse/developer-roadmap.git
synced 2026-10-25 09:34:00 +08:00
Arik Chakma
274082fd77
* refactor: clean to roadmap content * refactor: move shared helpers into scripts/lib
12 lines
720 B
Markdown
12 lines
720 B
Markdown
# Questions to Ask
|
|
|
|
- Are the new features reasonably documented?
|
|
- Are all relevant types of documentation covered, such as README, API docs, user guide, reference docs, etc?
|
|
- Is the documentation understandable and free of significant typos and grammar mistakes?
|
|
|
|
Learn more from the following resources:
|
|
|
|
- [@article@How to Write Software Documentation - Write the Docs](https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/)
|
|
- [@article@8 Essential Code Documentation Best Practices - Heretto](https://www.heretto.com/blog/best-practices-for-writing-code-documentation)
|
|
- [@article@Looking for Things in a Code Review - Google](https://google.github.io/eng-practices/review/reviewer/looking-for.html)
|