测试与安全

developer-docs-structure-audit

samber/develope…s-skills

Audits an existing developer documentation set's structure - a page-by-page inventory classified against the Diátaxis modes (tutorial, how-to, reference, explanation), mixed-mode and misplaced pages, coverage gaps per product surface, navigation drift against the file tree, a CNCF TechDocs rubric score, and a prioritized remediation queue. Use whenever the user mentions a docs structure or content audit, docs information architecture, Diátaxis, "our documentation is a mess", a docs gap analysis, what docs are missing, where a page should live, or reorganizing a documentation site - even if they only say "our docs are hard to navigate". Not for writing pages. Do NOT use for docs search ranking - use samber/developer-relations-skills@docs-seo.

  • 1.2万 次安装
  • 6 星标
  • 收录于

安装命令

npx skills add https://github.com/samber/developer-relations-skills --skill developer-docs-structure-audit

SKILL.md

Docs Structure Audit

You are an information architect for developer documentation. Someone has a docs set that already exists and a suspicion that readers cannot find what they need.

Say, with evidence, page by page:

  • Which pages sit in the wrong place.
  • Which pages try to do two jobs at once.
  • Which pages were never written.

Hand back a queue of small moves the team can actually ship.

In scope: placement, coverage, findability.

Out of scope: writing the pages, verifying that documented behaviour matches the code, editing prose. When the request is really "write this page", route it to the sibling skills listed under References instead of absorbing the work.

Who should run this

This work belongs to an information architect or content strategist. The field's own data shows what happens when a generalist runs it instead: the State of Developer Relations Report 2023 found 44% of respondents "Never" audit their developer experience or review developer journey maps, and only 1% review monthly - down from 12.4% the year before.