write-docs

Generate documentation by executing commands and capturing real output.

335|69|Updated Jun 27, 2025
One-click install
npx skills add https://github.com/vfarcic/dot-ai --skill write-docs-vfarcic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/vfarcic/dot-ai/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/vfarcic/dot-ai --skill write-docs-vfarcic

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of documentation by executing commands and capturing real-world output, ensuring accuracy and relevance.

Core Features & Use Cases

  • Accurate Example Generation: Never invent output; always use real responses from user interactions or command executions.
  • Step-by-Step Documentation: Writes documentation chunk-by-chunk, seeking user confirmation at each stage.
  • Use Case: When a new feature is developed, this Skill can be used to generate a comprehensive guide, including setup instructions and usage examples, by actually performing the setup and demonstrating the feature.

Quick Start

Use the write-docs skill to create a new guide for the 'knowledge base' feature.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I automate documentation generation with real command output?

You can automate documentation generation by executing commands and capturing real-world output directly, ensuring accuracy. This process validates prerequisites and writes guides chunk-by-chunk, confirming details with you at each stage to guarantee verified examples.

What is the best way to write API references without inventing examples?

The best way to write API references without inventing examples is to execute commands and capture real responses. This approach ensures all setup guides and feature documentation contain verified, accurate output instead of fabricated placeholders.

How do I update existing guides to include accurate new feature examples?

You can update existing guides by executing the relevant new feature commands and capturing their actual output. The documentation is revised chunk-by-chunk, seeking your confirmation at each stage to integrate accurate, verified examples into the existing material.

Does this documentation writing process validate prerequisites before generating guides?

Yes, the documentation writing process validates prerequisites before generating guides. It ensures the environment is properly configured by executing setup commands and capturing real responses, which forms the foundation for accurate user-focused feature documentation.

When do I need to use a chunk-by-chunk documentation writing process?

You need to use a chunk-by-chunk documentation writing process when generating comprehensive guides for new features or API references. This method validates prerequisites and seeks user confirmation at each stage, ensuring all captured command output and examples remain accurate.