Skip to content

dodycode/eng-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

eng-docs

Engineering documentation skill for AI agents. Contains templates and rules for creating ADR, RFC, Tech Design, TDD, and Postmortem documents.

What's Inside

File What
SKILL.md The skill file. AI agents read this to know how to create docs.
templates/adr/TEMPLATE.md Template for Architecture Decision Records
templates/rfc/TEMPLATE.md Template for Request for Comments
templates/tech-design/TEMPLATE.md Template for Technical Design Documents
templates/tdd/TEMPLATE.md Template for Test-Driven Development plans
templates/postmortem/TEMPLATE.md Template for Postmortem reports

How to Use

  1. Copy the template you need from templates/
  2. Rename it: 001-my-decision.md (ADR/RFC/Tech Design/TDD) or 2026-07-11-issue-name.md (Postmortem)
  3. Fill it in
  4. Put it in your project's docs/ folder

With AI Agents

If you use an AI coding agent, copy SKILL.md into your agent's skills or rules directory. The agent will read it and know how to create docs for you.

Writing Rules

These templates follow simple rules:

Rule Why
Plain English Easy to read for non-native speakers
No jargon Explain tech words in simple terms
Always visual Mermaid diagrams or tables for every explanation
Short sentences One idea per sentence

About

Engineering documentation skill for AI agents. Contains templates and rules for creating ADR, RFC, Tech Design, TDD, and Postmortem documents.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors