Skip to content

Documentation process

Use simple words and keep each document focused. The owner's latest instructions and the live project take precedence over older notes.

Information Place
Milestone order Roadmap
One goal, its status and checklist Tasks
Test steps, result and limits Testing
Current usage or system guidance Guides and development setup
Dated source maps, plans and evidence Document inventory and archive

Record who tested a result, what they did and what remains unverified. A passing check proves only its stated scope. Update one owning page and link to it instead of copying long checklists. Preserve history, authored data and recovery files; fix links when moving documents. Keep old paths required by project instructions working.

Use descriptive lowercase filenames with hyphens. Split long pages when doing so makes them easier to use, not just to meet a line count. Keep task status accurate, including blocked work and test limits.