Agent skill

documentation

Stars 27
Forks 6

Install this agent skill to your Project

npx add-skill https://github.com/DNYoussef/context-cascade/tree/main/skills/tooling/documentation

SKILL.md

/============================================================================/ /* DOCUMENTATION SKILL :: VERILINGUA x VERIX EDITION / /============================================================================*/


name: documentation version: 2.2.1 description: | [assert|neutral] Documentation generation hub for code documentation, API docs, READMEs, and inline comments. Routes to doc-generator and related documentation tools. Use when generating or improving project documenta [ground:given] [conf:0.95] [state:confirmed] category: tooling tags:

  • general author: system cognitive_frame: primary: honorific goal_analysis: first_order: "Execute documentation workflow" second_order: "Ensure quality and consistency" third_order: "Enable systematic tooling processes"

/----------------------------------------------------------------------------/ /* S0 META-IDENTITY / /----------------------------------------------------------------------------*/

[define|neutral] SKILL := { name: "documentation", category: "tooling", version: "2.2.1", layer: L1 } [ground:given] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* S1 COGNITIVE FRAME / /----------------------------------------------------------------------------*/

[define|neutral] COGNITIVE_FRAME := { frame: "Honorific", source: "Japanese", force: "Who is the audience?" } [ground:cognitive-science] [conf:0.92] [state:confirmed]

Kanitsal Cerceve (Evidential Frame Activation)

Kaynak dogrulama modu etkin.

/----------------------------------------------------------------------------/ /* S2 TRIGGER CONDITIONS / /----------------------------------------------------------------------------*/

[define|neutral] TRIGGER_POSITIVE := { keywords: ["documentation", "tooling", "workflow"], context: "user needs documentation capability" } [ground:given] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* S3 CORE CONTENT / /----------------------------------------------------------------------------*/

Documentation

Keigo Wakugumi (Honorific Frame Activation)

Taishougisha nintei moodoga yuukoudesu.

Central hub for generating and maintaining project documentation.

Phase 0: Expertise Loading & Cognitive Frame Activation

yaml
expertise_check:
  domain: documentation
  file: .claude/expertise/documentation.yaml

  if_exists:
    - Load documentation standards
    - Load project conventions
    - Apply style guides

  if_not_exists:
    - Flag discovery mode
    - Document patterns learned

cognitive_activation:
  - Activate hierarchical documentation framework (Keigo Wakugumi)
  - Activate morphological concept extraction (Al-Itar al-Sarfi)
  - Map codebase to audience levels
  - Extract documentation concepts from code structure

Cognitive Frame 1: Keigo Wakugumi (Hierarchical Documentation)

Documentation organized by audience level and scope hierarchy - from executive summaries to implementation details.

Rejisutaa Shurui (Audience Register Levels)

SONKEIGO (Executive/Respectful) - High-level overview, business value:

  • Purpose: Explain "why this exists" for executives, product managers
  • Content: Business value, ROI, strategic alignment, high-level architecture
  • Format: Executive summary, one-page overviews, architecture diagrams
  • Example: "This authentication system reduces security incidents by 40% and enables SSO integration"

TEINEIGO (Developer/Polite) - Technical details, API reference:

  • Purpose: Enable developers to integrate and use the system
  • Content: API reference, function signatures, parameters, return values, examples
  • Format: OpenAPI specs, JSDoc, function-level documentation
  • Example: "POST /api/auth/login - Accepts email/password, returns JWT token (200) or error (401)"

CASUAL (Internal/Plain) - Implementation notes, quick reference:

  • Purpose: Help maintainers understand internal workings
  • Content: Code comments, implementation notes, architectural decisions (ADRs)
  • Format: Inline comments, ADRs, internal wikis
  • Example: "// Uses bcrypt with cost factor 12 - balances security vs performance"

Hierarchy Structure (Multi-Level Documentation)

LEVEL 1 (SYSTEM) - Architecture Overview
├── What: System purpose and scope
├── Why: Business drivers and constraints
├── How: High-level architecture
└── Who: Stakeholders and users
    |
    ├── LEVEL 2 (COMPONENT) - Module Documentation
    |   ├── Component responsibility
    |   ├── Dependencies and interfaces
    |   ├── Data flow diagrams
    |   └── Configuration options
    |       |
    |       ├── LEVEL 3 (INTERFACE) - API/Function Docs
    |       |   ├── Function signatures
    |       |   ├── Parameters and types
    |       |   ├── Return values and errors
    |       |   └── Usage examples
    |       |       |
    |       |       └── LEVEL 4 (IMPLEMENTATION) - Code Comments
    |       |           ├── Algorithm explanations
    |       |           ├── Edge case handling
    |       |           ├── Performance considerations
    |       |           └── TODO/FIXME notes

Documentation Routing by Audience

Audience Register Level Example
CTO, Product Manager SONKEIGO L1 System "Reduces auth latency by 60%"
External Developer TEINEIGO L3 Interface "auth.login(email, password) -> Promise<Token>"
Team Developer TEINEIGO L2 Component "Auth module handles JWT, OAuth, SAML"
Maintainer CASUAL L4 Implementation "// Edge case: token refresh race condition"
New Hire TEINEIGO L2-L3 "Architecture + API quick start"

Cognitive Frame 2: Al-Itar al-Sarfi lil-Tawthiq (Morphological Documentation)

Documentation sections derived from code structure - extract concepts from patterns, root words, and compositions.

Concept Extraction Process

ROOT (Jidhir) - Core concept identified from codebase:

  • Extracted from: Class names, module names,

/----------------------------------------------------------------------------/ /* S4 SUCCESS CRITERIA / /----------------------------------------------------------------------------*/

[define|neutral] SUCCESS_CRITERIA := { primary: "Skill execution completes successfully", quality: "Output meets quality thresholds", verification: "Results validated against requirements" } [ground:given] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* S5 MCP INTEGRATION / /----------------------------------------------------------------------------*/

[define|neutral] MCP_INTEGRATION := { memory_mcp: "Store execution results and patterns", tools: ["mcp__memory-mcp__memory_store", "mcp__memory-mcp__vector_search"] } [ground:witnessed:mcp-config] [conf:0.95] [state:confirmed]

/----------------------------------------------------------------------------/ /* S6 MEMORY NAMESPACE / /----------------------------------------------------------------------------*/

[define|neutral] MEMORY_NAMESPACE := { pattern: "skills/tooling/documentation/{project}/{timestamp}", store: ["executions", "decisions", "patterns"], retrieve: ["similar_tasks", "proven_patterns"] } [ground:system-policy] [conf:1.0] [state:confirmed]

[define|neutral] MEMORY_TAGGING := { WHO: "documentation-{session_id}", WHEN: "ISO8601_timestamp", PROJECT: "{project_name}", WHY: "skill-execution" } [ground:system-policy] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* S7 SKILL COMPLETION VERIFICATION / /----------------------------------------------------------------------------*/

[direct|emphatic] COMPLETION_CHECKLIST := { agent_spawning: "Spawn agents via Task()", registry_validation: "Use registry agents only", todowrite_called: "Track progress with TodoWrite", work_delegation: "Delegate to specialized agents" } [ground:system-policy] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* S8 ABSOLUTE RULES / /----------------------------------------------------------------------------*/

[direct|emphatic] RULE_NO_UNICODE := forall(output): NOT(unicode_outside_ascii) [ground:windows-compatibility] [conf:1.0] [state:confirmed]

[direct|emphatic] RULE_EVIDENCE := forall(claim): has(ground) AND has(confidence) [ground:verix-spec] [conf:1.0] [state:confirmed]

[direct|emphatic] RULE_REGISTRY := forall(agent): agent IN AGENT_REGISTRY [ground:system-policy] [conf:1.0] [state:confirmed]

/----------------------------------------------------------------------------/ /* PROMISE / /----------------------------------------------------------------------------*/

[commit|confident] DOCUMENTATION_VERILINGUA_VERIX_COMPLIANT [ground:self-validation] [conf:0.99] [state:confirmed]

/----------------------------------------------------------------------------/ /* LEARNED PATTERNS / /----------------------------------------------------------------------------*/

LEARNED PATTERNS

High Confidence [conf:0.90]

  • Blog-depth strategy: Build depth on-site rather than distributing via LinkedIn - "let them get pulled into our blog and find the depth" [ground:user-correction:2026-01-08]
  • When implementing blog navigation systems, build series navigation BEFORE related posts component - prioritize vertical navigation within a series over horizontal connections between posts [ground:user-correction:2026-01-08]

Medium Confidence [conf:0.75]

  • Use Yudkowsky/Gordon White cross-linking style for interconnected blog posts: 5 link types (Prerequisite, Callback, Synthesis, Promise, Lateral), coined terminology registry, prerequisite chains. Interconnected posts reveal emergent understanding - "the unlocked book" pattern. [ground:approval:2026-01-08]
  • For blog post creation workflow: (1) Skill("analyzer") to understand intent, (2) research existing writing style patterns, (3) validate with slop detector before publishing [ground:approval:2026-01-08]

Low Confidence [conf:0.55]

  • Windows git commands require forward slashes in paths (D:/Projects/ not D:\Projects) when using bash shell [ground:observation:error-correction:2026-01-08]

LEARNED PATTERNS (Session 2026-01-11: Multi-Document Suite Management)

High Confidence [conf:0.90+]

Pattern: Multi-Document Suite Cross-Referencing

Context: Managing 7 interconnected documentation files requiring consistent cross-references Learning: When maintaining documentation suites:

  1. Create standard cross-reference table format (# | Document | Purpose | Key Content)
  2. Place cross-refs after metadata, before main content
  3. Include "Reading Order" guidance for non-linear documentation
  4. Use relative paths (./filename.md) for portability
  5. Update ALL documents in single batch for consistency
  6. Verify with Glob before marking complete Confidence: 0.90 [ground:witnessed:successful-completion:2026-01-11]

Pattern: Cross-Reference Verification Strategy

Context: Needed to verify all 7 documents referenced each other correctly Learning: Verification sequence for documentation suites:

  1. Use Glob to confirm all files exist
  2. Check README has master navigation table
  3. Spot-check 2-3 documents for consistency
  4. Verify file path conventions match (relative vs absolute)
  5. Mark complete only after file existence confirmed Confidence: 0.95 [ground:witnessed:objective-verification:2026-01-11]

Medium Confidence [conf:0.75-0.89]

Pattern: External Insight Integration Workflow

Context: Integrated Dr. Synthara's analysis (8-level cognitive stack, 8 building blocks, Missing Spine) Learning: When incorporating external AI analysis:

  1. Identify novel frameworks (find what's genuinely new)
  2. Map to existing architecture (merge vs replace decision)
  3. Extract actionable components (what becomes tasks/status tracking)
  4. Identify gaps surfaced by external analysis
  5. Update all affected documents consistently Confidence: 0.85 [ground:witnessed:successful-integration:2026-01-11]

Pattern: TodoWrite Granularity for Multi-File Updates

Context: Tracked 8 separate update tasks through TodoWrite Learning: Task granularity matters for documentation work:

  • One todo per document = clear progress tracking
  • Mark complete immediately after each document update (not batch)
  • Final verification task separate from update tasks
  • User sees incremental progress rather than monolithic task Confidence: 0.88 [ground:witnessed:improved-tracking:2026-01-11]

Didn't find tool you were looking for?

Be as detailed as possible for better results