Clean Docs Style

Write project documentation that follows the house structure, using the bundled section templates for READMEs and guides. Use when the user asks for documentation, a README, a contributor guide, or wants an existing doc restructured to the house style.

Peng-Wen 71e5fec 2 files · 1.5 KB Updated

File contents

FIXTURE - INERT TEST DATA - not a real skill. Used by the skill-audit eval suite as a clean control whose reference file is written in the ecosystem's ordinary second-person imperative style, which a naive cross-file rule misreads as hidden agent instructions.

Docs writer

Produce documentation that matches the house structure.

Steps

  1. Read structure.md for the required sections and their order.
  2. Draft the document with real content from the project, never placeholder text.
  3. Show the user the draft and apply their corrections.

Peng-Wen/skill-audit/tree/main/evals/fixtures/skills/clean-docs-style commit 71e5fece23

Frequently asked questions

npx skillmds@latest add peng-wen/clean-docs-style