documentation-writer

Generate module READMEs, user guides, and technical references from source code.

8|1|Updated Mar 30, 2025
One-click install
npx skills add https://github.com/C0ntr0lledCha0s/logseq-template-graph --skill documentation-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/C0ntr0lledCha0s/logseq-template-graph/tree/main/.claude/skills/documentation-writer
Command: npx skills add https://github.com/C0ntr0lledCha0s/logseq-template-graph --skill documentation-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual documentation is often outdated, inconsistent, and a drain on developer time. This skill automates the creation and updating of high-quality, user-friendly documentation, ensuring your project always has clear and accurate guides.

Core Features & Use Cases

  • Module README Generation: Automatically create or update README.md files for Logseq template modules, detailing classes, properties, and usage examples.
  • User Guide Creation: Generate step-by-step guides for features, including prerequisites, examples, and troubleshooting.
  • Use Case: After creating a new medical module, use this skill to instantly generate a comprehensive README.md for it, detailing all new classes, properties, and how users can leverage them.

Quick Start

Document the person module, generating a README.md file that includes an overview, class and property lists, and usage examples.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I automate documentation generation from my code?

Documentation automation extracts information directly from source files and templates to generate accurate guides without manual writing. This skill analyzes your codebase to produce module READMEs, user guides, and API references that stay synchronized with your actual implementation, eliminating outdated docs.

Can I generate README files automatically for my modules?

Yes. This skill generates comprehensive README.md files for individual modules by analyzing source code to extract classes, properties, and usage patterns, then structuring them with overviews, property lists, and working examples matched to your project's documentation style.

What's the best way to keep technical documentation current with code changes?

Automated documentation generation ties docs directly to source analysis, updating content whenever you request regeneration. By extracting information from live code rather than maintaining separate documents, your technical references, user guides, and API docs remain accurate without manual synchronization.

Does this work with markdown-based documentation?

Yes. This skill generates documentation in markdown format, producing README.md files, structured guides, and technical references that follow markdown conventions and integrate seamlessly into projects already using markdown for knowledge management.

Can I create user guides and API references automatically?

This skill generates step-by-step user guides with prerequisites, examples, and troubleshooting sections, as well as API references and technical documentation, all extracted from your codebase and templates to provide complete, accurate reference material.

What if my documentation needs to follow specific project formatting standards?

The skill applies your project's documentation style and guidelines during generation, ensuring all output—whether module READMEs, user guides, or technical references—maintains consistent formatting, terminology, and structure across your entire documentation set.