documentation-writer

Create and update project documentation with templates and INDEX.md maintenance.

1|1|Updated Nov 8, 2025
One-click install
npx skills add https://github.com/RasmusGodske/dev-agent-workflow --skill documentation-writer-rasmusgodske
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/RasmusGodske/dev-agent-workflow/tree/main/project-roles/skills/documentation-writer
Command: npx skills add https://github.com/RasmusGodske/dev-agent-workflow --skill documentation-writer-rasmusgodske

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures all project documentation is consistently structured, styled, and maintained, eliminating fragmented information and reducing the effort required to keep documentation up-to-date and discoverable.

Core Features & Use Cases

  • Convention-Driven Documentation: Automatically loads and applies project rules for documentation structure, templates, and writing style.
  • INDEX.md Maintenance: Guides on how to update the central documentation index, ensuring new documents are always discoverable and integrated.
  • Quality Gate: Acts as a final check to ensure all documentation, whether created manually or from research reports, meets project standards.
  • Use Case: After implementing a new API, activate this skill to generate its documentation. It will guide you to create the file in the correct docs/ subdirectory, use the right template, and automatically update docs/INDEX.md, ensuring consistency and discoverability.

Quick Start

Activate the documentation-writer skill to create new documentation for the PaymentGateway integration, ensuring it follows the project's structure and updates docs/INDEX.md.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I keep project documentation consistent across markdown files and README?

Documentation consistency is maintained by applying project conventions automatically. This skill loads rules from .claude/rules/documentation/, enforces naming standards like lowercase-hyphen file names, applies templates to docs/ and README files, and ensures all documentation follows the same structure and style throughout your codebase.

How do I update the documentation index when adding new docs?

When you create new documentation files, the INDEX.md is updated automatically to reflect additions. This skill guides you through creating files in the correct docs/ subdirectory, using the right template, and integrating them into INDEX.md so all new documentation remains discoverable and linked from the central index.

Can I automate documentation creation for new API implementations?

Yes. After implementing a new API, activate this skill to generate documentation following project structure. It creates the file in the appropriate docs/ subdirectory using project templates, includes code references with line numbers, links related documentation, and updates INDEX.md automatically for full integration.

What documentation standards does this enforce?

The skill enforces project-specific documentation conventions including file naming (lowercase-hyphen), directory structure in docs/, template usage, code reference formatting with line numbers, internal linking between related docs, and INDEX.md maintenance. All standards load from .claude/rules/documentation/ so they stay aligned with your project.

Does this work for existing documentation that needs updating?

Yes. This skill handles both creation of new documentation and editing of existing docs. It acts as a quality gate to ensure manually created or research-based documentation meets project standards, applies conventions consistently, and maintains proper linking and INDEX.md integration.

Why should I use templates for technical documentation?

Templates ensure technical documentation maintains consistent structure, covers required sections, and follows your project's writing style and conventions. They reduce decision fatigue, improve discoverability through standardized formatting, and make documentation easier to maintain and update as your codebase evolves.