developer-docs
Developer documentation
This skill uses Vercel's Writing Guidelines and c15t's writing-docs, with the existing FixMySlop manifest/link checks, Octocode reader-task distinctions and source corrections retained in WRITING-AND-PUBLISHING.md. It owns the documentation workflow; prose editing and AI-writing-pattern detection stay in anti-slop-writing, and attempted onboarding audits stay in agent-dx-audit. [Vercel, writing-guidelines; c15t, writing-docs; MrSpideyNihal/FixMySlop, fixmyslop/core/slop/rules_docs.py; bgauryy/octocode, octocode-documentation]
Apply only the routes and checks for the selected job. Read a linked skill's named file from its installed folder when available, or from the linked source. Report an unavailable required reference instead of inventing it. [skill-authoring, DISTRIBUTION.md#composing-skills]
| The job | Read |
|---|---|
| Select this skill, its boundaries and required evidence | SKILL.md |
| Plan a reader task, write the page, source its examples, document customization, maintain navigation and redirects, and inspect generated output | WRITING-AND-PUBLISHING.md |
The rules
- Give each page one reader task and content type. Establish the result, framework, router, deployment, prerequisites and failure cases before writing; keep shared explanations canonical. [Vercel, writing-guidelines; c15t, writing-docs; bgauryy/octocode, octocode-documentation/references/diataxis.md]
- Read the current source before describing the API. Verify exports and examples; source wiring snippets from code that CI builds or type-checks. Label fragments and preserve the distinction between generated docs and their editable sources. [c15t, writing-docs]
- Make each retrieved section usable alone. Lead with the answer, name the API and conditions, and include the imports, paths, setup and expected result needed to use a snippet. [Vercel, writing-guidelines; c15t, writing-docs]
- Document the actual customization and deployment contract. Check each adapter, show real components from the documented revision, and keep demos isolated and resettable. [c15t, writing-docs]
- Maintain the published paths and generated output. Register public pages, record moved or removed routes and their redirects, inspect generated Markdown, and report what was compiled, exercised in a browser or checked only against source. [c15t, writing-docs]