documentation-architecture

Create and update canonical architecture documents under Documentation/Arquitetura/.

Updated Jan 6, 2026
One-click install
npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-architecture
Source: https://github.com/cslsoftwares/ParamentersORM/tree/main/.cursor/skills/documentation-architecture_V1.1.0
Command: npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables teams to create and maintain canonical architecture documents under Documentation/Arquitetura/ using the canonical template. It ensures architecture documentation is consistent, properly scoped, and aligned with the project hub.

Core Features & Use Cases

  • Create and update architecture docs for a specific module or theme using the canonical template.
  • Enforce consistent structure, scoping, and cross-references across Documentation/Arquitetura/.
  • Update the hub registry as part of the orchestration workflow.

Quick Start

Provide a module name and version to generate or refresh the canonical Architecture_<Module>_Vx.y.md document.

Frequently Asked Questions about documentation-architecture

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

FAQPage Schema
How do I create consistent architecture documentation for a specific module?

To create architecture documentation, provide a module name and version to automatically generate a canonical Architecture_<Module>_Vx.y.md document. This enforces a consistent template structure, section boundaries, and cross-references.

What is canonical architecture documentation and why do I need it?

Canonical architecture documentation ensures your project's architectural records are consistent, properly scoped, and aligned with the project hub. It solves the problem of scattered, unstructured design docs by enforcing a standard template.

How do I update existing architecture markdown files without breaking cross-references?

Updating architecture markdown files safely requires refreshing the canonical document by providing the module name and new version. This process automatically maintains template structure, section boundaries, versioning, and cross-references.

Can I automatically update a documentation hub when architecture docs change?

Yes, updating the hub registry is part of the orchestration workflow when you generate or refresh an architecture document. This ensures the hub remains aligned with the latest module documentation automatically.

Does this approach to architecture documentation work for individual modules and broader themes?

Yes, the canonical architecture documentation applies to both specific modules and broader project themes. It maintains consistent scoping and structure across the Documentation/Arquitetura/ directory regardless of the subject.

What are the limitations of automating architecture documentation with a canonical template?

The automation is limited to enforcing template structure, section boundaries, versioning, and cross-references. It requires providing a specific module name and version, and operates strictly within the Documentation/Arquitetura/ directory.