documentation-writer
Documentation Writer creates complete project documentation covering README files, API references, and inline code comments in multiple formats. It provides structured templates and examples to help you document features, installation steps, usage patterns, and contribution guidelines.
Documentation Writer generates comprehensive project documentation including README files, API references, and code comments.
AI-generated summary based on this skill's SKILL.md
Install
AIDotNet/MoYuCode/documentation-writer · repository language: TypeScript
git clone https://github.com/AIDotNet/MoYuCode
cp -r MoYuCode/skills/community/documentation-writer ~/.claude/skills/documentation-writernpx skillfed install AIDotNet/MoYuCode/documentation-writerFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
What can Documentation Writer help me generate?
Documentation Writer creates comprehensive project documentation including README files, API references, inline code comments, and docstrings across multiple programming languages. The skill produces structured templates and examples covering features, installation steps, usage patterns, and contribution guidelines to help you document your entire codebase.
Can Documentation Writer generate README file automatically?
Yes, Documentation Writer can automatically generate README files for your project. It creates structured README documentation that includes project overview, installation instructions, usage examples, and contribution guidelines tailored to your project's needs.
How does Documentation Writer handle multiple programming languages?
Documentation Writer supports creating inline code comments and docstrings for multiple languages including TypeScript (JSDoc), Python (docstrings), C# (XML documentation), and others. It adapts the documentation format to match each language's conventions and best practices.
Does Documentation Writer create API documentation?
Documentation Writer specializes in creating API documentation as a core feature. It generates comprehensive API docs that document endpoints, parameters, responses, and usage examples, helping both developers and users understand your API's capabilities.
What documentation formats does Documentation Writer support?
Documentation Writer produces multiple documentation formats including project README files, API reference documentation, inline code comments, docstrings, architecture documentation, and setup guides. This comprehensive approach ensures all aspects of your codebase are properly documented.
Can Documentation Writer document my entire codebase automatically?
Documentation Writer helps you document your codebase by automatically generating structured documentation across multiple levels—from project-wide README and architecture docs to inline comments and API references. This systematic approach ensures comprehensive coverage of your code structure and usage patterns.
SKILL.md
rendered from the published skill — quoted content, verbatim
Documentation Writer Skill
Description
Generate comprehensive documentation for code, APIs, and projects.
Trigger
/docscommand- User requests documentation
- User needs README or API docs
Prompt
You are a technical writer that creates clear, comprehensive documentation.
README Template
```markdown
Project Name
Brief description of what this project does.
Features
- ✅ Feature 1
- ✅ Feature 2
- 🚧 Feature 3 (in progress)
Quick Start
```bash
Clone the repository
git clone https://github.com/user/project.git cd project
Install dependencies
npm install
Start development server
npm run dev ```
Installation
Prerequisites
- Node.js >= 18
- PostgreSQL >= 14
Environment Variables
```env DATABASE_URL=postgresql://user:pass@localhost:5432/db JWT_SECRET=your-secret-key ```
Usage
```typescript import { Client } from 'my-library';
const client = new Client({ apiKey: 'xxx' }); const result = await client.doSomething(); ```
API Reference
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 1 file
skills/community/documentation-writer/SKILL.md