write-documentation-guide

Community

Standardized, cross-referenced docs with DocFX.

Authoraalmada
Version1.0.0
Installs0

System Documentation

What problem does it solve?

BookStore teams often struggle with keeping documentation consistent, up-to-date, and properly cross-referenced. This skill enforces a standardized process to create DocFX-ready guides that align with project conventions, reducing duplication and onboarding friction.

Core Features & Use Cases

  • Enforces a consistent guide structure aligned with BookStore conventions.
  • Integrates with DocFX templates and navigation.
  • Supports creating new guides and updating existing ones.
  • Use Case: When adding API, architectural, or operator guides, generate a DocFX-ready document scaffold.

Quick Start

Create a new guide in docs/guides/{topic-name}-guide.md using templates/guide-template.md, then update docs/toc.yml and build the DocFX site to verify navigation and formatting.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: write-documentation-guide
Download link: https://github.com/aalmada/BookStore/archive/main.zip#write-documentation-guide

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 223,000+ vetted skills library on demand.