module-docs

Completes release-notes.md, docs/README.md, and .imodspec metadata for Intent Architect modules.

23|10|Updated Aug 31, 2017
One-click install
npx skills add https://github.com/IntentArchitect/Intent.Modules --skill module-docs-intentarchitect
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: module-docs
Source: https://github.com/IntentArchitect/Intent.Modules/tree/main/Tests/ModuleBuilderSkills/.opencode/skills/module-docs
Command: npx skills add https://github.com/IntentArchitect/Intent.Modules --skill module-docs-intentarchitect

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Module maintainers often ship Intent Architect modules with incomplete or inconsistent documentation: missing release notes, sparse READMEs, and misconfigured .imodspec metadata. This Skill brings all three artifacts up to a canonical format without overwriting existing content or fabricating information. ## Core Features & Use Cases - Release Notes Formatting: Writes or completes release-notes.md entries using strict conventions (### Version X.Y.Z headings, New Feature/Improvement/Fixed prefixes, reverse chronological order, breaking-change note blocks). - README Generation: Fills gaps in docs/README.md following a canonical structure with What This Module Generates, feature sections with C# code examples, Module Settings, and Related Modules. - Metadata Management: Updates .imodspec fields (tags, authors, releaseNotes, projectUrl) while directing summary/description edits to the Application Settings page, since the Software Factory overwrites them. - Use Case: A maintainer preparing a module release asks for documentation to be completed; the Skill reads the .imodspec, templates, and factory extensions, then produces a compliant release-notes entry, README sections, and tag metadata. ## Quick Start Ask the assistant to complete the documentation for this module using the module-docs skill, pointing it at the module directory containing the .imodspec file.

Frequently Asked Questions about module-docs

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

FAQPage Schema
How do I write release notes for an Intent Architect module?▼

Use a ### Version X.Y.Z heading per release in reverse chronological order, with single-line bullets prefixed only by New Feature:, Improvement:, or Fixed:. Strip any -pre.X suffix from the version and place breaking changes in a warning note blockquote under the heading.

What sections should an Intent Architect module README contain?▼

The canonical structure is an H1 with the module name, an opening purpose paragraph, What This Module Generates, one H2 feature section per capability with C# code examples, Module Settings, Related Modules, and optionally External Resources. Omit Installation, Changelog, and Table of Contents.

Why do my .imodspec summary and description edits keep reverting?▼

The Software Factory overwrites summary, description, and iconUrl on every run, so edits in the .imodspec file are silently discarded. Set summary and description through the Application Settings page in Intent Architect instead; both fields receive the same single value.

When should I not use the module-docs skill?▼

Do not use it for the automatic same-turn documentation update after an observable code change; that is handled by module-docs-chore. It also never creates release-notes.md unprompted or fabricates a projectUrl when the maintainer has not supplied one.

How do I choose tags for an Intent Architect module?▼

Include the technology name (e.g. nservicebus, entityframework), architectural pattern (messaging, cqrs, outbox), layer (infrastructure, application), and stack (csharp, dotnet), aiming for 3-7 keywords. Avoid generic words like module, common, or helper unless the module is genuinely a base utility.