Documentation.

Technical writing and documentation practices. Covers 6 topics.

• Documentation · 1 of 3

  README & Project Documentation

  Which root-level filename does GitHub automatically render as the project landing page on the repository's main tab?

  AINDEX.mdBLANDING.mdCABOUT.mdDREADME.md

• Documentation · 2 of 3

  Docs-as-Code Workflow

  API reference pages are edited manually and diverge from schema. Which approach keeps them in sync without relying on anyone to remember an update?

  AMaintain API reference in a separate repository managed by tech writersBLink each reference page to its schema file so readers can compare the twoCRequire manual API doc updates as part of every pull request checklistDGenerate reference docs from source contracts

• Documentation · 3 of 3

  Diagrams & Visual Communication

  Operational runbooks reference outdated topology diagrams. Which process most directly prevents that drift?

  AAdd a 'last reviewed' date to every diagram so readers can see how old each one isBLink diagram updates to infrastructure change workflowsCStore diagrams in a dedicated design repository with version historyDSchedule quarterly diagram reviews with infrastructure team participation