engineering-docs

Generate markdown files with YAML frontmatter for solved technical problems.

2|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/mistakeknot/Clavain --skill engineering-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: engineering-docs
Source: https://github.com/mistakeknot/Clavain/tree/main/skills/engineering-docs
Command: npx skills add https://github.com/mistakeknot/Clavain --skill engineering-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

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.

Frequently Asked Questions about engineering-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document solved debugging problems for future reference?

Document solved debugging problems by generating markdown files with structured YAML frontmatter that captures symptoms, root cause, resolution, and prevention tips. This ensures technical solutions are categorized and easily discoverable for future troubleshooting.

What is the best way to organize technical troubleshooting documentation?

Organize troubleshooting documentation into predefined categorized directories to ensure efficient retrieval. Files are sorted into specific folders like performance-issues, making institutional knowledge management structured and easily searchable.

Do I need to use YAML frontmatter for markdown knowledge management files?

Yes, you need to use YAML frontmatter for markdown knowledge management files. Adherence to a strict YAML schema is required to validate entries and guarantee discoverability and consistency across all documented solutions.

How does validating a YAML schema improve technical documentation searchability?

Validating a YAML schema improves technical documentation searchability by enforcing consistent metadata structure across all entries. This strict validation process ensures that categorized markdown files remain uniformly discoverable during future retrieval.

Can I automatically categorize resolved issue notes into specific directories?

You can automatically categorize resolved issue notes into specific directories. The documentation process organizes markdown files into predefined categories, such as placing performance issue entries directly into a dedicated directory.