skills.rest
HACK-WU
HACK-WUCOMMUNITY
Explore all skills by this author →
GitHub

document-writer

Generates README and sub-documents for projects using type-specific documentation strategies.

2|Updated Jun 8, 2026
Search Tags:#documentation#markdown#github#readme#api reference#generate#project docs
One-click install
npx skills add https://github.com/HACK-WU/skills --skill document-writer-hack-wu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-writer
Source: https://github.com/HACK-WU/skills/tree/main/skills/document-writer
Command: npx skills add https://github.com/HACK-WU/skills --skill document-writer-hack-wu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing consistent, complete project documentation is tedious and often results in hollow READMEs with placeholder text, missing examples, and no clear structure. This Skill automates the creation of professional README files and sub-documents by detecting the project type and applying the right documentation strategy. ## Core Features & Use Cases - Automatic Project Type Detection: Scans package.json, setup.py, go.mod, and directory structures to classify projects as library/SDK, CLI tool, web application, plugin, or hybrid. - Strategy-Driven Generation: Applies type-specific chapter templates, split thresholds, and example rules; README stays under 120 lines as an index hub while details split into sub-documents like api-reference.md or configuration.md. - Quality Enforcement: Built-in checks (Q-01 to Q-06 forbidden patterns, P-01 to P-06 professionalism rules) eliminate placeholders, vague statements, and examples without input/output. - Use Case: Point it at a newly built CLI tool with no docs; it detects the CLI type, generates a README with quick-start terminal output examples, plus command-reference.md and configuration.md when thresholds are met. ## Quick Start Ask the agent to generate a README and full documentation for this project, and it will scan the codebase, confirm the project type, and produce the document set.

Frequently Asked Questions about document-writer

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

FAQPage Schema
How do I generate a README for my project automatically?▼

Invoke the document-writer skill on your project directory. It scans manifest files like package.json or go.mod, detects the project type, and generates a README plus any needed sub-documents following type-specific templates.

How to write documentation for a CLI tool project?▼

The skill detects CLI projects via bin entries or frameworks like commander and cobra, then generates a README with terminal output examples plus command-reference.md and configuration.md when command or config counts exceed thresholds.

Does it support projects that already have a README?▼

Yes, an update mode preserves confirmed existing content, fills missing sections and examples, adds sub-documents required by the type strategy, and rewrites low-density chapters. Changes are labeled as kept, added, or rewritten for confirmation.

When should I not use this documentation generator?▼

Skip it for single-section requests, pure documentation repositories without code, quick informal drafts, API contract design docs, or technical design documents. Those cases are handled by direct answers or other specialized skills.

What quality checks does generated documentation go through?▼

Output is validated against rules Q-01 to Q-06 banning placeholders, output-less commands, vague wording, and empty sections, plus P-01 to P-06 professionalism checks covering badges, code blocks, terminology consistency, and first-screen value density.

Related Skills

Explore More Software Engineering Skills→
SoltusSoltus
1

cypress-docs

Access official Cypress documentation for commands, APIs, assertions, and configuration.

Community
Intermediate
ThiagoGuislottiThiagoGuislotti
2

docs-release-engineer

Generate repository documentation and release artifacts with semantic versioning and link validation.

Community
Intermediate
spencerbeggsspencerbeggs

design-sync

Align design documentation with current codebase architecture and flag unsafe changes.

Community
Advanced
GenuinehGenuineh

docs-specs

Generate structured technical specification documents with defined sections for architecture and APIs.

Community
Intermediate