add-new-module

Generate module scaffolds with headers, docs, and index entries.

3|Updated Jun 3, 2022
One-click install
npx skills add https://github.com/Hohlas/SoSimple --skill add-new-module
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-new-module
Source: https://github.com/Hohlas/SoSimple/tree/main/.kilocode/skills/add-new-module
Command: npx skills add https://github.com/Hohlas/SoSimple --skill add-new-module

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating consistent, well-documented modules and their data-flow definitions is error-prone and time-consuming; this skill automates scaffolding for new modules and updating documentation.

Core Features & Use Cases

  • Module scaffolding: generate a new module with a file header, documentation page, and indexing entries.
  • Documentation maintenance: document existing modules by creating missing docs and updating references.
  • Data flow integration: automatically update or create entries in MODULE_INDEX.md and DATA_FLOW.md to reflect new modules.
  • Workflow automation: streamline the process from prompting for directory, purpose, inputs and outputs to opening the edited file in your editor.

Quick Start

Execute create module [name], provide the directory, one-line purpose, and inputs/outputs when prompted to generate headers, docs, and index entries and open the file in your editor.

Frequently Asked Questions about add-new-module

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

FAQPage Schema
How do I automate module scaffolding and documentation for a new codebase component?

Automate module scaffolding by executing a create module command, providing the directory, purpose, and inputs/outputs to generate file headers, documentation pages, and index entries automatically.

How does module scaffolding update data flow documentation?

Module scaffolding updates data flow documentation by automatically creating or modifying entries in DATA_FLOW.md and MODULE_INDEX.md to accurately reflect the new module and its defined inputs and outputs.

What files do I need to set up before automating module creation?

Before automating module creation, you need a project structure containing MODULE_INDEX.md and optionally DATA_FLOW.md to accurately map the new module and its data flows during generation.

Can I document existing modules with missing data flow definitions?

Yes, you can document existing modules by creating missing documentation pages, adding file headers, and updating references in MODULE_INDEX.md and DATA_FLOW.md to maintain consistency.

What is the best way to maintain index entries when adding new modules?

The best way to maintain index entries is using a scaffolding workflow that automatically generates headers, docs, and updates MODULE_INDEX.md entries based on prompted directory and data flow details.

Why does module scaffolding require specific directory and input details?

Module scaffolding requires directory and input details to accurately generate file headers, documentation pages, and update both MODULE_INDEX.md and DATA_FLOW.md entries for the new component.