backend-documenter

Creates Spanish backend documentation for Supabase RPC functions, Edge Functions, and RLS policies.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping backend documentation accurate and organized is hard when RPC functions, Edge Functions, tables, triggers, and RLS policies live scattered across migrations and source code. This Skill produces structured, canonical backend docs under docs/backend so teams stop duplicating or losing technical knowledge. ## Core Features & Use Cases - Structured backend docs: Generates documentation for Supabase RPC functions, Edge Functions, tables, triggers, RLS policies, validations, and business logic, organized by module (pedidos, ordenes-compra, productos, proveedores, api, supabase). - Code-grounded writing: Inspects migrations, Edge Function sources, RLS SQL files, Angular services, and database types before writing, so docs reflect real behavior. - Bilingual convention: Skill instructions are in English while all docs/backend output is written in technical Spanish, with fixed English section slugs for consistency. - Use Case: After adding a new Postgres RPC for order approval, ask the Skill to document it; it updates functions/index.md, creates the module detail page from the template, updates indexes, and hands off the Testing section to backend-tester. ## Quick Start Document the new aprobar-pedido-item RPC function under docs/backend following the project template and update the relevant indexes.

Frequently Asked Questions about backend-documenter

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

FAQPage Schema
How do I document a Supabase RPC function in a project?▼

Add a summary row for the RPC in docs/backend/functions/index.md, then create a detailed page in the owning module folder using the provided template. Inspect the migration SQL first so parameters, return values, and side effects are documented accurately.

How to document Supabase Edge Functions and RLS policies?▼

Edge Functions are cataloged in docs/backend/functions/edge/index.md with trigger, auth, and I/O details, while RLS policies go in the module doc plus the cross-cutting docs/backend/supabase folder. Read the policy SQL to capture roles and conditions.

Does this skill run tests for the backend documentation?▼

No, it never executes tests. It only documents the Testing section with expected verification types, file paths, and scenarios marked as pendiente, then hands off execution to the backend-tester skill.

What language are the generated backend docs written in?▼

All files created under docs/backend are written in technical Spanish, while section headings like Summary, Purpose, and Testing stay in English for consistency. The skill's own instructions remain in English.

Where should backend documentation live to avoid duplication?▼

Each idea has one canonical location: RPC summaries in functions/, domain logic in module folders, HTTP contracts in api/, and cross-cutting RLS or workflows in supabase/. The docs/08-sql folder must not be used.