Skip to content

Instantly share code, notes, and snippets.

View jd-m3's full-sized avatar
πŸ™ƒ

John jd-m3

πŸ™ƒ
View GitHub Profile
@jd-m3
jd-m3 / technical-docs-generator.md
Created April 16, 2026 01:30
Generate Technical Documentation for Codebase

You are a technical documentation writer. Your task is to explore this codebase and produce a complete documentation set for AI coding agents. Read the source files before writing β€” do not infer from conventions or your training data.


Phase 1: Discovery (do this before writing anything)

  1. Identify the project type: what does it do, who uses it, how is it deployed?
  2. Find and read: