documentation
Documentation standards for documentation in Content environments. Covers
Works with
--- name: documentation description: Documentation standards for documentation in Content environments. Covers license: MIT --- # Documentation > **Quick Navigation:** > Level 1: [Quick Start](#level-1-quick-start) (5 min) → Level 2: [Implementation](#level-2-implementation) (30 min) → Level 3: [Mastery](#level-3-mastery-resources) (Extended) --- ## Level 1: Quick Start ### Core Principles 1. **Best Practices**: Follow industry-standard patterns for content 2. **Security First**: Implement secure defaults and validate all inputs 3. **Maintainability**: Write clean, documented, testable code 4. **Performance**: Optimize for common use cases ### Essential Checklist - [ ] Follow established patterns for content - [ ] Implement proper error handling - [ ] Add comprehensive logging - [ ] Write unit and integration tests - [ ] Document public interfaces ### Quick Links to Level 2 - [Core Concepts](#core-concepts) - [Implementation Patterns](#implementation-patterns) - [Common Pitfalls](#common-pitfalls) --- ## Level 2: Implementation ### Core Concepts This skill covers essential practices for content. **Key areas include:** - Architecture patterns - Implementation best practices - Testing strategies - Performance optimization ### Implementation Patterns Apply these patterns when working with content: 1. **Pattern Selection**: Choose appropriate patterns for your use case 2. **Error Handling**: Implement comprehensive error recovery 3. **Monitoring**: Add observability hooks for production ### Common Pitfalls Avoid these common mistakes: - Skipping validation of inputs - Ignoring edge cases - Missing test coverage - Poor documentation --- ## Level 3: Mastery Resources ### Reference Materials - [Related Standards](../../docs/standards/) - [Best Practices Guide](../../docs/guides/) ### Templates See the `templates/` directory for starter configurations. ### External Resources Consult official documentation and community best practices for content.
More Writing & Documentation skills
paper-context-resolver
lllllllama/rigorpilot-skills
Rigor Paper Context helper for README-first deep learning repo reproduction. Use only when the README and repository files leave a narrow reproduction-critical gap and the task is to resolve a specific paper detail such as dataset split, preprocessing, evaluation protocol, checkpoint mapping, or runtime assumption from primary paper sources while recording conflicts. Do not use for general paper summary, repo scanning, environment setup, command execution, title-only paper lookup, or replacing README guidance by default.
repo-intake-and-plan
lllllllama/rigorpilot-skills
Rigor Intake helper for README-first deep learning repo reproduction. Use when the task is specifically to scan a repository, read the README and common project files, extract documented commands, classify inference, evaluation, and training candidates, and return the smallest trustworthy reproduction plan to the main orchestrator. Do not use for environment setup, asset download, command execution, final reporting, paper lookup, or end-to-end orchestration.
minimal-run-and-audit
lllllllama/rigorpilot-skills
Rigor Run skill for README-first deep learning repo reproduction. Use when the task is specifically to capture or normalize evidence from the selected smoke test or documented inference or evaluation command and write standardized `repro_outputs/` files, including patch notes when repository files changed. Do not use for training execution, initial repo intake, generic environment setup, paper lookup, target selection, hidden scientific-meaning changes, or end-to-end orchestration by itself.
