engineering-docs

Community

Capture solved problems as searchable knowledge.

Authormistakeknot
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill streamlines the process of documenting solved technical problems, ensuring that solutions are captured, categorized, and easily discoverable for future reference.

Core Features & Use Cases

  • Automated Documentation: Generates markdown files with structured YAML frontmatter for solved issues.
  • Categorization & Searchability: Organizes documentation into predefined categories for efficient retrieval.
  • Use Case: After successfully debugging a complex N+1 query issue, use this Skill to automatically create a detailed entry in the docs/solutions/performance-issues/ directory, complete with symptoms, root cause, resolution, and prevention tips.

Quick Start

Use the engineering-docs skill to document the recent fix for the 'authentication-module' issue.

Dependency Matrix

Required Modules

None required

Components

scriptsreferencesassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: engineering-docs
Download link: https://github.com/mistakeknot/Clavain/archive/main.zip#engineering-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.