documentacion-proyecto

Organizes and maintains technical documentation for Angular and Supabase projects without duplication.

Updated Jan 31, 2023
One-click install
npx skills add https://github.com/Briian3306/Transporte --skill documentacion-proyecto-briian3306
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentacion-proyecto
Source: https://github.com/Briian3306/Transporte/tree/main/ibarra-app/.agents/skills/documentacion-proyecto
Command: npx skills add https://github.com/Briian3306/Transporte --skill documentacion-proyecto-briian3306

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation in growing projects becomes scattered, duplicated, and outdated. This Skill provides a canonical methodology to create, refactor, and maintain documentation for the ibarra-app project (Peajes module), ensuring each topic has a single canonical location with proper indexes and cross-references. ## Core Features & Use Cases - Canonical documentation structure: Organizes docs by domain and artifact type (modules, components, tables, backend/RPC, tests) with a defined folder taxonomy and INDEX.md chain. - Refactor methodology: Inventories existing docs, detects duplicates, designates canonical documents, and updates parent indexes and cross-links. - Ready-to-use templates: Provides Markdown templates for tests, components, tables, SQL/RPC, and index pages, plus a minimal-update rule mapping each code change to exactly which docs to touch. - Use Case: After implementing a new Supabase RPC for the Peajes module, ask the agent to document it; it will place the doc under docs/backend/, update the module and table references, and refresh the index chain without rewriting unrelated docs. ## Quick Start Ask the agent to document the Peajes wizard component following the project documentation methodology and place it in the correct docs folder with updated indexes.

Frequently Asked Questions about documentacion-proyecto

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

FAQPage Schema
How do I organize technical documentation for an Angular project?▼

Organize documentation by domain and artifact type: modules for business features, components for reusable UI pieces, tables for data grids, and backend for SQL/RPC. Each folder needs an INDEX.md, and every topic should have exactly one canonical document with cross-links to related docs.

How to refactor duplicated project documentation?▼

Inventory existing files, group them by intent rather than historical names, detect duplicates, and designate one canonical document per topic. Then move or rewrite content so each file has a single responsibility, create folder indexes, and add cross-references.

Where should Supabase RPC and SQL migration documentation go?▼

Document RPCs and migrations under docs/backend/, with functions/ for the RPC catalog, a domain subfolder like peajes/ for detail, and supabase/ for workflow and testing. The SQL source of truth stays in supabase/migrations/; the deprecated docs/08-sql/ folder must not be used.

When should I update existing documentation after a code change?▼

Update only what the change actually affects: a shared component change touches its guide, folder index, and consuming modules; a module change touches its doc and architecture if flows change; an SQL/RPC change touches docs/backend/ plus affected modules. Never rewrite neighboring docs whose behavior did not change.

What sections should a technical documentation page include?▼

Each document needs a brief summary, an internal index, a functionality section, dependencies or relationships, examples or snippets where they add clarity, and references to related documents. Templates for tests, components, tables, SQL/RPC, and indexes are provided in plantillas.md.