write-documentation-guide

Create and update DocFX-ready documentation guides for BookStore projects.

15|Updated Dec 25, 2025

Search Tags:#templates #documentation #navigation #guides #docs-structure #DocFX

Ready to run

npx skills add https://github.com/aalmada/BookStore --skill write-documentation-guide

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: write-documentation-guide
Source: https://github.com/aalmada/BookStore/tree/main/.claude/skills/write-documentation-guide
Command: npx skills add https://github.com/aalmada/BookStore --skill write-documentation-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about write-documentation-guide

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

FAQPage Schema

How do I create standardized documentation guides with DocFX?▼

To create standardized documentation guides with DocFX, scaffold a new document in docs/guides/{topic-name}-guide.md using the templates/guide-template.md file. This ensures your guide aligns with project conventions and is ready for the DocFX build workflow.

How do I update cross-references and navigation for existing DocFX guides?▼

To update cross-references and navigation for existing DocFX guides, modify the content within docs/guides and then update the docs/toc.yml file. Rebuild the DocFX site to verify that all formatting and navigation links work correctly.

What is the best way to maintain documentation consistency across BookStore projects?▼

The best way to maintain documentation consistency across BookStore projects is to enforce a standardized process using a guide template and DocFX navigation integration. This reduces duplication and onboarding friction by ensuring all guides follow project conventions.

Does this DocFX documentation workflow support updating existing guides?▼

Yes, this DocFX documentation workflow supports updating existing guides within the docs/guides directory. It ensures proper cross-references and navigation updates are applied when modifying API, architectural, or operator documentation.

Why do I need to update docs/toc.yml when adding a new documentation guide?▼

You need to update docs/toc.yml when adding a new documentation guide to integrate the new page into the project's DocFX navigation. This ensures the guide is accessible in the generated site and cross-references resolve correctly.