Skip to content

docs: Phase 1 - Documentation & Standards Foundation #379

@mcj-coder

Description

@mcj-coder

Summary

Establish foundation documentation for consistent skills by creating the local skill format specification and skill dependency matrix.

Scope

New Files to Create

  • docs/SKILL-FORMAT.md - Local specification defining required/optional sections and frontmatter fields
  • docs/skill-dependency-matrix.md - Visual Mermaid diagram of skill relationships and interaction matrix

Updates Required

  • Add references/README.md to all 37 skill directories with references folders

Acceptance Criteria

  • docs/SKILL-FORMAT.md defines:
    • Required sections: Frontmatter, Overview, When to Use, Core Workflow
    • Optional sections: Red Flags, Examples, References
    • Frontmatter fields: name, description, priority, category, requires
  • docs/skill-dependency-matrix.md contains:
    • Mermaid diagram showing skill relationships
    • Matrix showing: invokes, requires, incompatible-with relationships
  • All 37 references/ directories have a README.md index file
  • npm run lint passes with zero errors/warnings

Test Plan

  • Lint passes: npm run lint
  • All internal links in new docs resolve correctly
  • References/README.md files accurately list contents of each directory

Related

Part of Skills Repository Improvement Plan (Phase 1 of 4)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions