doc-editing

Community

Facilitates structured documentation writing, ensuring clarity and consistency.

Authorcjohnhanson
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the challenge of producing comprehensive and coherent documentation by guiding the user through a structured process, from defining the scope to final review.

Core Features & Use Cases

  • Structured Documentation Process: Guides users through a three-phase process to create well-organized documentation.
  • Type Discipline: Enforces a single Diátaxis type per document to maintain clarity.
  • Reference Verification: Ensures technical accuracy by verifying claims against source code or CLI outputs.
  • Use Case: When drafting a complex project guide, this Skill ensures that the documentation is both accurate and easy to follow.

Quick Start

Use the doc-editing skill to start a new documentation project by providing the document type, audience, purpose, and scope.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-editing
Download link: https://github.com/cjohnhanson/almanac/archive/main.zip#doc-editing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.