Zum Inhalt springen
Kitbay
Einreichen
Skill

docs-standards

MITAktualisiert am 11. Nov. 20265.616GitHub-Sterne

A Squad template, copied into the gh-aw repository, describing how Squad's own documentation is written.

Was der Skill vermittelt

A Squad template, copied into the gh-aw repository, describing how Squad's own documentation is written. It applies Microsoft Style Guide rules such as sentence-case headings, active voice, second person, present tense and no ampersands in prose, then adds Squad's page layout: a preview warning, a prompt to try, an overview and then content sections, with related links at the end. It also asks writers to update the expected-page arrays in the docs build test whenever they add pages. Examples show correct and incorrect page openings.

Funktionen

  • Apply Microsoft Style Guide rules to docs
  • Lay out Squad feature and scenario pages
  • Keep the docs build test in step with new pages