System and architecture guides
Explain components, dependencies, data flow and ownership at a useful level. Keep diagrams linked to the system version or current source they describe.
Services
Choose a first audience and task rather than trying to describe every system at once.
Explain components, dependencies, data flow and ownership at a useful level. Keep diagrams linked to the system version or current source they describe.
Organize supported requests, authentication setup, examples and error handling around the intended developer task. Use safe sample values and verify examples against an appropriate environment.
Document prerequisites, authorized actions, expected results and stop conditions. Give the reader a clear escalation route rather than an unexplained command list.
Turn repeated explanations into findable articles. Distinguish an explanation from a procedure, and show which product or version the guidance applies to.
Review navigation, search, permissions and the contribution process. Name owners and update triggers so the library can stay useful after the initial writing.
Discuss the first audience and task. For a source-grounded assistant, see AI assistants and knowledge systems.