The answer
Yes. Link to the authoritative design references and record relevant decisions locally. Make version ownership clear so an assistant can distinguish approved guidance from drafts.
Why should system, database, and API documentation be stored in the repository?
Can external design documents still be used alongside repository files?
More FAQs in Why should system, database, and API documentation be stored in the repository?
A clearly named documentation directory with a short index is usually sufficient. Follow existing repository conventions so developers and assistants can locate the references consistently.
No. Update documentation when behavior, contracts, setup, or important decisions change. Internal edits that preserve those facts may not need additional documentation.
Still have questions?
Browse all our FAQs or reach out to our support team
Want to upskill yourself?
Your learning library
Small steps. Big possibilities.
Find your next course. Build something great.