Purpose
Theknowledge-base-templates skill provides reusable templates and structural guidelines for establishing and maintaining codebase knowledge bases, internal wikis, concept maps, and module documentation. It enforces ownership, pruning, and structured categorization across single-project and monorepo architectures.
Core Principles: Ownership, Pruning & Diátaxis
- A Knowledge Base Needs Ownership & Pruning:
- Every KB document must designate an owner or maintainer team and specify a review cadence or
stale_afterdate. - Routinely prune, archive, or delete stale or duplicate pages to prevent knowledge decay.
- Every KB document must designate an owner or maintainer team and specify a review cadence or
- Diátaxis Quadrant Separation:
- Categorize wiki pages into distinct quadrants:
- Tutorials: Step-by-step learning paths for onboarding.
- How-To Guides: Goal-focussed instructions for completing specific operational tasks.
- Reference: Technical specifications, parameter dictionaries, and architectural diagrams.
- Explanation: In-depth theoretical discussions, design rationale, and background context.
- Categorize wiki pages into distinct quadrants:
Standard Template Schemas
1. Architecture & Module Overview Template
- Owner & Review Cadence: Designated maintainer team, owner identity, and mandatory review cadence (or
stale_afterdate). - Title & Purpose: High-level summary of the subsystem or module.
- Component Diagram: Mermaid flowchart or sequence diagram.
- Key File Maps: Table listing primary source files and their responsibilities.
- Operational Dependencies: Upstream services and downstream consumers.
2. Operational Runbook Template
- Owner & Review Cadence: Designated maintainer team, owner identity, and mandatory review cadence (or
stale_afterdate). - Overview & Severity: Impact summary and alert thresholds.
- Prerequisites: Access levels, tools, and CLI requirements.
- Step-by-Step Remediation: Sequential recovery instructions.
- Verification: Commands to confirm resolution.
When to Use This Skill
- Setting up an internal repository wiki or knowledge base structure.
- Creating onboarding guides, architecture maps, or troubleshooting runbooks.
- Organizing monorepo documentation to maintain cross-module consistency.
Deep State of Mind (DSOM) For My AI Protocol | Harisfazillah Jamel (LinuxMalaysia) | 2026-09-02 Standard: UK English | DBP-standard Bahasa Melayu Malaysia (Piawai) | GNU General Public License v3.0