Documentation.

Technical writing and documentation practices. Covers 6 sub-skills.

• 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 reduces drift?

  AMaintain API reference in a separate repository managed by tech writersBUse a documentation framework that imports code examples from testsCRequire 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 reduces drift?

  AUse automated infrastructure discovery tools to generate topology diagramsBLink diagram updates to infrastructure change workflowsCStore diagrams in a dedicated design repository with version historyDSchedule quarterly diagram reviews with infrastructure team participation