skills.rest
speqqai
speqqaiOFFICIAL
Explore all skills by this author →
GitHub

documentation-writer

Organize internal technical documentation using a write-validate-fix loop.

Updated Apr 27, 2026
Search Tags:#documentation#writing#onboarding#knowledge#internal#content-management
One-click install
npx skills add https://github.com/speqqai/claude --skill documentation-writer-speqqai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/speqqai/claude/tree/main/skills/create-documentation
Command: npx skills add https://github.com/speqqai/claude --skill documentation-writer-speqqai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps teams create and maintain coherent internal documentation for architecture, features, onboarding, and operations, reducing knowledge silos and onboarding time.

Core Features & Use Cases

  • Write-validate-fix loop to ensure documentation quality and coherence across the docs site.
  • Structure content under content/internal/ and content/guides/ with MDX pages and a consistent navigation scheme.
  • Update or create documentation when features are completed or when asked to "document", "write docs", or "update docs" to maintain alignment with the codebase.
  • Example: documenting a new feature's architecture, onboarding guides, and operational runbooks to demonstrate end-to-end coverage.

Quick Start

Survey existing content, draft new docs for the feature, then run the write-validate-fix loop to reach coherence.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I maintain internal technical documentation as my codebase changes?▼

To maintain internal technical documentation, you apply a write-validate-fix loop to architecture, feature specs, and operational guides. This process reduces knowledge silos and keeps docs aligned with the codebase.

What is the best way to structure onboarding guides and feature specs using Nextra?▼

The best way to structure onboarding guides and feature specs is using a Nextra-compatible structure with MDX pages under content/internal/ and content/guides/. This ensures a consistent navigation scheme across your documentation site.

How do I write consistent internal documentation for a new software feature?▼

You write consistent internal documentation by surveying existing content first, drafting new architecture or onboarding docs, then running a write-validate-fix loop. This enforces adherence to your project's documentation style guide.

Does this documentation writer work with MDX pages and content directories?▼

Yes, this documentation writer works directly with MDX pages by organizing and maintaining content within the content/internal/ and content/guides/ directories. It enforces a Nextra-compatible structure for your docs site.

When should I update internal documentation to prevent knowledge silos?▼

You should update internal documentation when features are completed or when asked to document, write docs, or update docs. Regular updates prevent knowledge silos and reduce onboarding time for new team members.

Related Skills

Explore More Content & Communication Skills→
professor-moodyprofessor-moody
1

prowler-docs

Enforce Prowler documentation style, terminology, and MDX formatting standards.

Community
Basic
windyskywindysky

moai-library-nextra

Automate Nextra documentation setup and maintenance with MDX and i18n.

Community
Advanced
roycolumbia-coderoycolumbia-code

gsd-docs-update

Update documentation files to reflect codebase changes and verify without generation.

Community
Intermediate
wangjiawei508wangjiawei508
2

web-article-extractor

Extract web article text, images, and metadata into Markdown format.

Community
Intermediate