⚡AgentSkills
✍️ Technical Writing · Documentation Systems

Run docs through the same pipeline as code

Versioned markdown, PR reviews, link checks, and preview deploys keeping docs trustworthy.

intermediate~30 minTechnical WritersDeveloper AdvocatesEngineers Who Document

Steps

  1. 1Store docs beside code or in sibling repo with same review gates
  2. 2CI checks links, style rules, and builds previews per PR
  3. 3Enforce frontmatter metadata: owner, last-verified date, audience
  4. 4Broken-build rule applies: failing docs checks block merges
  5. 5Auto-generate changelog-driven updates for API surfaces
  6. 6Quarterly stale-sweep: unverified pages get flagged visibly

Common Pitfalls

  • ▲Wiki graveyards outside any workflow
  • ▲Screenshots rotting after every UI release

Commands

Install with skills CLI
$ npx skills add aniruddhaadak80/skills --skill docs-systems-docs-as-code-workflow
Install globally
$ npx skills add aniruddhaadak80/skills --skill docs-systems-docs-as-code-workflow -g

Tags

#docs-as-code#ci#markdown#technical-writing#docs-systems

Related skills

Sort docs into types readers recognizefoundation

Tutorials vs how-tos vs reference vs explanation — separating modes ends most doc confusion.

✍️ Technical Writing·~30m
Open →