documentation-writer
CommunityAutomate documentation, keep your project clear and current.
Content & Communication#automation#documentation#markdown#knowledge management#technical writing#content generation#README
AuthorC0ntr0lledCha0s
Version1.0.0
Installs0
System Documentation
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.mdfiles 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
medicalmodule, use this skill to instantly generate a comprehensiveREADME.mdfor 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.
Dependency Matrix
Required Modules
None requiredComponents
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: documentation-writer Download link: https://github.com/C0ntr0lledCha0s/logseq-template-graph/archive/main.zip#documentation-writer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.