muse_generate_dev_document
Generate structured development documents like README, DESIGN, TUTORIAL, or CHANGELOG in Markdown format with badges, API references, and multilingual support.
Instructions
Generates README, DESIGN, TUTORIAL, or CHANGELOG documents in Markdown format. Supports multiple languages, badges, API reference, FAQ, and more.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentType | Yes | Type of document to generate (README, DESIGN, TUTORIAL, CHANGELOG, API, ARCHITECTURE) | |
| title | No | Title of the document | |
| projectName | No | Name of the project | |
| description | No | Project or document description | |
| language | No | Language for section headers (default: en) | |
| author | No | Author name | |
| version | No | Version number | |
| license | No | License type (e.g., MIT, Apache-2.0) | |
| repository | No | Repository URL | |
| badges | No | Shield.io badges | |
| features | No | List of features | |
| installation | No | Installation instructions | |
| apiReference | No | API documentation | |
| faq | No | Frequently asked questions | |
| contributors | No | List of contributors | |
| codeContexts | No | Array of code contexts to include | |
| designDecisions | No | Array of design decisions to include | |
| customSections | No | Custom sections to add (key: section title, value: content) | |
| includeTableOfContents | No | Whether to include a table of contents |