skills/project-docs/SKILL.md
Conventions for writing project documents: technical language, medium complexity, Chilean peso economics, and structured output under docs/. Trigger: When generating project documents, proposals, reports, or any formal deliverable.
npx skillsauth add 333-333-333/agents project-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
docs/The docs/ directory is split into two top-level areas:
| Directory | Purpose | Organized by |
|-----------|---------|--------------|
| docs/latex/ | LaTeX documents (reports, proposals, analyses) | Business/project area |
| docs/diagrams/ | Mermaid diagrams (.mmd) | Software domain |
docs/latex/docs/latex/
├── finance/ # Financial analysis, budgets, cost projections
│ ├── budget-2025.tex
│ └── cost-analysis.tex
├── project/ # Project plans, proposals, status reports
│ ├── proposal.tex
│ └── status-report-q1.tex
├── processes/ # Process documentation, workflows, SOPs
│ ├── onboarding.tex
│ └── ci-cd-pipeline.tex
├── legal/ # Contracts, terms, compliance
├── marketing/ # Campaigns, brand guidelines
├── engineering/ # Technical design docs, architecture
└── research/ # Market research, benchmarks, studies
Financial analysis, budgets, ROI, costs → latex/finance/
Project plans, proposals, status updates → latex/project/
Workflows, SOPs, pipelines, methodologies → latex/processes/
Contracts, compliance, legal terms → latex/legal/
Campaigns, positioning, brand materials → latex/marketing/
Architecture, design docs, technical specs → latex/engineering/
Studies, benchmarks, market analysis → latex/research/
If a document spans multiple domains, place it in the primary domain and add a reference note in the secondary.
docs/diagrams/Organized by software domain (not diagram type). The diagram type is encoded in the filename prefix.
docs/diagrams/
├── auth/
│ ├── flow-login.mmd
│ ├── seq-oauth-google.mmd
│ └── er-users.mmd
├── payments/
│ ├── flow-checkout.mmd
│ ├── seq-flow-cl-webhook.mmd
│ └── state-payment-lifecycle.mmd
├── booking/
│ └── flow-reservation.mmd
└── architecture/ # Cross-cutting, system-level diagrams
├── c4-system-context.mmd
└── deployment-gcp.mmd
| Prefix | Diagram type | Example |
|--------|-------------|---------|
| flow- | Flowchart / process flow | flow-login.mmd |
| seq- | Sequence diagram | seq-oauth-google.mmd |
| er- | Entity-relationship | er-users.mmd |
| class- | Class diagram | class-booking-model.mmd |
| state- | State diagram | state-payment-lifecycle.mmd |
| c4- | C4 model diagram | c4-system-context.mmd |
| gantt- | Gantt chart | gantt-mvp-timeline.mmd |
Create subdirectories matching software domains as they emerge (e.g., auth/, payments/, booking/, notifications/). Use architecture/ for system-wide diagrams that don't belong to a single domain.
| Rule | Example |
|------|---------|
| Subdirectory in English (lowercase) | finance/, auth/, payments/ |
| File name in English (lowercase, hyphens) | cost-analysis.tex, flow-login.mmd |
| No spaces, no uppercase, no special characters | budget-2025.tex (not Budget 2025.tex) |
| Aspect | Convention | |--------|-----------| | Language | Spanish (Chile), except technical terms that are standard in English | | Register | Technical-professional, direct, impersonal where possible | | Complexity | Medium — accessible to stakeholders with general technical literacy, not overly academic | | Voice | Prefer impersonal constructions: "Se estima...", "El análisis indica..." over "Yo creo..." | | Technical terms | Use original English terms for established concepts (e.g., sprint, pipeline, deploy, stakeholder) with brief explanation on first use if the audience may not know them |
✅ "El costo estimado del módulo de autenticación es de $2.500.000 CLP,
considerando 3 sprints de desarrollo."
❌ "Yo pienso que el módulo de autenticación podría llegar a costar
alrededor de dos millones y medio de pesos más o menos."
✅ "Se implementará un pipeline de CI/CD (integración y despliegue continuo)
utilizando GitHub Actions."
❌ "Vamos a hacer un sistema automático para subir el código."
ALL monetary values MUST be expressed in pesos chilenos (CLP).
| Rule | Example |
|------|---------|
| Symbol | $ followed by amount, then CLP suffix for clarity |
| Thousands separator | Period (.) |
| No decimal places | CLP has no centavos in practice |
| Full format | $2.500.000 CLP |
| In tables/shorthand | $2.500.000 (CLP implied by context) |
When referencing values originally in foreign currency:
El servicio de hosting tiene un costo de USD $49/mes
(~$45.000 CLP/mes al tipo de cambio de $920 CLP/USD, enero 2026).
When quantifying social or economic impact:
El costo operativo mensual equivale a 2,3 UTM
($143.000 CLP aprox., valor UTM enero 2026: $62.171).
When economic data is required and not available locally:
Nota: Valores económicos calculados con datos de enero 2026.
Verificar vigencia antes de utilizar para decisiones financieras.
Every formal document SHOULD follow this general structure:
Use hierarchical numbering: 1., 1.1., 1.1.1.
| Skill | Relationship |
|-------|-------------|
| corporate-colors | Use corporate palette for styled/branded documents |
| latex-corporate-docs (future) | LaTeX-specific implementation of these conventions |
# Create a new LaTeX document directory
mkdir -p docs/latex/{domain}
# Create a new diagram domain directory
mkdir -p docs/diagrams/{domain}
# Verify document structure
tree docs/ 2>/dev/null || find docs/ -type f | sort
docs/latex/{domain}/, diagrams under docs/diagrams/{domain}/testing
Review Flutter components and screens for UX/UI compliance. Trigger: When user invokes /ux-review command or requests UX audit.
development
TypeScript strict patterns and best practices. Trigger: When implementing or refactoring TypeScript in .ts/.tsx (types, interfaces, generics, const maps, type guards, removing any, tightening unknown).
testing
Testing philosophy and strategy for every feature: test pyramid, mandatory levels per change type, completion checklist, and skill delegation. Trigger: When planning tests for a feature, reviewing test coverage, defining acceptance criteria, or asking what tests a change needs.
development
Terraform security practices: sensitive variables, secret management, state protection, .gitignore patterns, and CI/CD credential handling. Trigger: When handling secrets in Terraform, configuring state backends, reviewing .gitignore for Terraform, or setting up CI/CD pipelines for infrastructure.