Documentation

Create detailed implementation plans with bite-sized tasks for engineers with zero codebase context

This skill should be used when users request code review, refactoring, or code quality improvements for Ruby codebases. Apply Sandi Metz's four rules for writing maintainable object-oriented code - classes under 100 lines, methods under 5 lines, no more than 4 parameters, and controllers instantiate only one object. Use when users mention "Sandi Metz", "code quality", "refactoring", or when reviewing Ruby code for maintainability.

Write READMEs for software projects. The skill should be used when writing or revising a README or README.md file.

Document findings and maintain task notes using Flow framework. Use when user says "document", "document this", "document finding", "add notes", "add this to notes", "write this down", "summarize", "summarize this", "generate changelog", "create changelog", or wants to capture discoveries. Helps update task Notes sections, create summaries with /flow-summarize, and keep documentation synchronized with work. Focuses on concise, actionable documentation.

Use when design is complete and you need detailed implementation tasks for engineers with zero codebase context - creates comprehensive guides with exact file paths, code examples, and verification steps; task granularity 2-5 minutes per step

Searches the aem.live documentation for information on features of the platform. Use this skill when you need more information about a feature, want guidance on how to implement a feature, and using existing tools you have to search the web isn't turning up relevant results.

Markdown document content generation guide. Use this skill when you need to create Markdown documents that can be previewed via `frago view`. Covers element support, Mermaid charts, and best practices.

Master index for Starwards development workflow - shows when to use each skill, workflow diagram, and how skills integrate together

CROSS-CUTTING: API contract design patterns for architects and implementers.Provides REST API design patterns, GraphQL schema design, API versioning strategies,error response formats, pagination patterns, and API documentation standards.Use when: designing API contracts, choosing between REST/GraphQL, planning versioning,defining error formats, implementing pagination, documenting APIs.

ARCHITECT PHASE: Architectural design patterns, component templates, and system design guidance.Provides proven architectural patterns including microservices, layered architecture,event-driven systems, C4 diagram templates, API contract formats, and design anti-patterns.Use when: designing system architecture, creating component diagrams, defining interfaces,planning component boundaries, choosing architectural patterns, organizing system modules,or when user mentions: architecture, components, system design, diagrams, C4, microservices,API contracts, service boundaries, architectural patterns.Use for: component design, interface definition, system boundaries, dependency management,architecture documentation, design patterns, integration patterns.DO NOT use for: code implementation details, specific framework syntax, database schema design,frontend-specific patterns, testing strategies, or security implementation (use dedicated skills).

CODE PHASE (Database): Data layer implementation patterns and best practices.Provides schema design patterns, query optimization strategies, indexing guidelines,data integrity constraints, migration patterns, and database security practices.Use when: designing schemas, writing queries, optimizing performance, planningmigrations, implementing data validation, ensuring data integrity.

TEST PHASE: Testing strategies, patterns, and quality assurance workflows.Provides test strategy frameworks, coverage guidelines, unit/integration/e2e patterns,performance testing approaches, and security testing checklists.Use when: designing test strategies, writing tests, evaluating coverage,planning QA workflows, implementing test automation.

PREPARE PHASE: Research methodologies and documentation gathering workflows.Provides systematic research approaches, source evaluation criteria, documentationtemplates, API exploration techniques, and technology comparison frameworks.Use when: conducting technology research, evaluating documentation sources,comparing framework options, analyzing API documentation, gathering requirements.

Automatically discover diagram and visualization skills when working with flowcharts, sequence diagrams, architecture diagrams, ER diagrams, Gantt charts, mindmaps, or any visual documentation using Mermaid.js. Activates for documentation and visualization tasks.

Comprehensive toolkit for detecting and eliminating "AI slop" - generic, low-quality AI-generated patterns in natural language, code, and design. Use when reviewing or improving content quality, preventing generic AI patterns, cleaning up existing content, or enforcing quality standards in writing, code, or design work.

Refactor codebases using Design by Typed Holes methodology - iterative, test-driven refactoring with formal hole resolution, constraint propagation, and continuous validation. Use when refactoring existing code, optimizing architecture, or consolidating technical debt through systematic hole-driven development.

Generates and displays OVN-Kubernetes network topology diagrams showing logical switches, routers, ports with IP/MAC addresses in Mermaid format

Infrastructure and development cost estimation for technical projects. Use when planning budgets, evaluating build vs buy decisions, or projecting TCO for architecture choices.

Detect common technical and organizational anti-patterns in proposals, architectures, and plans. Use when strategic-cto-mentor needs to identify red flags before they become problems.

This skill should be used when writing, modifying, or reorganizing documentation in docs/learned/. Use when creating new documents, updating frontmatter, choosing categories, creating index files, updating routing tables, or moving files between categories. Essential for maintaining consistent documentation structure.