skills.rest
human-centric-engineering
human-centric-engineeringOFFICIAL
Explore all skills by this author →
WebsiteGitHub

docs-writer

Creates and updates Markdown documentation verified against actual codebase implementation.

Updated Jul 28, 2026
Search Tags:#documentation#markdown#anti-patterns#technical writing#ai context#code verification#docs maintenance
One-click install
npx skills add https://github.com/human-centric-engineering/resparkable --skill docs-writer-human-centric-engineering
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/human-centric-engineering/resparkable/tree/main/.claude/skills/docs-writer
Command: npx skills add https://github.com/human-centric-engineering/resparkable --skill docs-writer-human-centric-engineering

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code as projects evolve, leaving stale file paths, wrong function names, and "Planned" markers on shipped features. This Skill writes and maintains documentation that is verified against the actual implementation before anything is published. ## Core Features & Use Cases - Code-Verified Documentation: Reads implementation files first, then documents real function names, paths, and signatures instead of guessed patterns. - Structured Writing Patterns: Enforces actionable-over-descriptive style, anti-patterns-before-patterns sections, quick-reference tables, and concise code examples. - Drift Repair Workflow: Provides a checklist for comparing existing docs to code, removing outdated status markers, and fixing broken links. - Use Case: After shipping a new rate-limiting utility, ask the Skill to document it — it reads lib/security/rate-limit.ts, writes accurate usage examples, and updates related docs and indexes. ## Quick Start Ask the assistant to document a newly implemented utility or update an existing doc that has drifted from the current code.

Frequently Asked Questions about docs-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep project documentation in sync with code?▼

Verify every documented pattern against the actual implementation before writing. Read the source files to confirm function names, paths, and signatures, then remove outdated "Planned" markers and update code examples to match current behavior.

How to write documentation optimized for AI agents?▼

Write actionable instructions over descriptive prose, document project-specific quirks like environment variables and file locations, and show anti-patterns before correct patterns. Use tables for API references and keep code examples short with real imports.

What structure should a new documentation domain follow?▼

Create a folder with an overview.md entry point that links to topic-specific files. Each document should have a title, quick reference section, main patterns with real code examples, anti-patterns, and links to related documentation.

Why does documentation drift happen and how do I fix it?▼

Drift happens when code changes but docs are not updated, leaving wrong paths and stale status markers. Fix it by comparing each documented pattern to the implementation, correcting inaccuracies, and removing examples for features that no longer exist.

When should status markers like Planned be removed from docs?▼

Remove "Planned" or "Guidance" markers as soon as the feature is implemented and verified in code. Only keep status markers for genuinely unimplemented features, documented in a separate Roadmap or Future section.

Related Skills

Explore More Content & Communication Skills→
human-centric-engineeringhuman-centric-engineering

docs-writer

Creates and updates Markdown documentation verified against actual codebase implementation.

Official
Intermediate
prototypdigitalprototypdigital

docs-upkeep

Update and validate documentation alongside code changes within version control workflows.

Official
Advanced
crewrigcrewrig
20

tester

Plan behavior-based tests with edge-case selection and regression checks.

Official
Advanced
patricio0312revpatricio0312rev
5

jsdoc-typescript-docs

Generate API documentation from JSDoc comments in TypeScript projects.

Community
Intermediate