module-docs-chore

Update module release notes, README, imodspec metadata, and icons alongside observable changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Module documentation often drifts out of sync with actual behavior because updates are treated as follow-up tasks. This Skill ensures release notes, README files, .imodspec metadata, and module icons are updated in the same turn as any consumer-observable change to an Intent Architect module. ## Core Features & Use Cases - Artifact Routing: Directs each type of documentation to the right artifact — release notes for version entries, docs/README.md for behavior descriptions, .imodspec for tags, and Application Settings for summary/description. - Release Notes Governance: Respects the module's Include Release Notes setting, never creates a release-notes.md that was opted out of, and formats entries as grouped one-line bullets under the plain version heading. - Metadata & Icon Upkeep: Keeps summary, description, and lowercase hyphenated tags current, copies authorship from sibling modules, and creates an SVG icon only when none exists. - Use Case: After adding a new template and setting to an Intent Architect module, run this chore to add a grouped release-notes bullet, update the README settings table, and refresh the module's tags in one pass. ## Quick Start Update the module's release notes, README, and metadata to reflect the new template and setting I just added.

Frequently Asked Questions about module-docs-chore

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

FAQPage Schema
How do I update module release notes in Intent Architect?▼

Add a single bullet under the current version in release-notes.md, but only if the module's Include Release Notes setting is ticked and the file already exists. Strip any -pre.# suffix from the version heading and group related changes into one entry.

When should module documentation be updated?▼

Update documentation in the same turn as any consumer-observable change: new or removed templates, new settings or stereotypes, changed configuration defaults, or behavioral fixes. Internal refactors with no observable effect need no documentation.

Where do I edit a module's summary and description in Intent Architect?▼

Edit the summary and description on the Application Settings page, not in the .imodspec file. The Software Factory overwrites the manifest's summary and description fields from that value on every run, so direct manifest edits are discarded.

Should I create a release-notes.md if the module doesn't have one?▼

No. If the module has no release-notes.md, do not create one — its absence is a deliberate maintenance choice. If Include Release Notes is ticked but the file is missing, report the inconsistency instead of silently creating the file.

What format should module tags use in the .imodspec file?▼

Tags are lowercase and space-separated, with multi-word concepts joined by hyphens (e.g., module-builder, azure-service-bus). Aim for a handful covering the technology, concern, and target stack, skipping generic words like module or common.

Can I replace an existing module icon?▼

No. An existing icon is never overwritten, even if it looks dated. Icons are only created when the module has none, sourced from the .imodspec summary, tags, or CONTEXT.md, ideally via the module-svg-icon skill.