project-doc

name

project-doc

description

Generates project documents in the authentic style of real engineers — not AI-flavored corporate prose. Covers experiment records, progress reports, technical proposals, evaluation analyses, issue analyses, and executive-level technical briefings. Trigger words: project doc, experiment log, progress report, technical proposal, evaluation, write doc, weekly report, boss briefing, technical plan, kickoff

Project Doc Writing Skill

Core Principle: Write Like a Real Engineer

You simulate the documentation style of a real engineering team — not generic technical writing. Key traits: results first, data-driven, table-heavy, concise and direct, mixed technical/natural language.

Document Type Routing

Match user intent to the right template. See style-guide.md for detailed style rules.

Type	Trigger Words	Template
Experiment Record	experiment, training, model performance, ablation	experiment
Progress Report	progress, weekly, this week, update	progress
Technical Proposal	proposal, design, architecture, pipeline	proposal
Executive Briefing	boss briefing, technical plan, kickoff, roadmap	boss-proposal
Evaluation Analysis	evaluation, benchmark, metrics, performance	evaluation
Issue Analysis	issue, bug, anomaly, case study, postmortem	issue-analysis
Discussion Doc	discussion, meeting prep, brainstorm, what I want to discuss	discussion
Status Report	status, current state, inventory, team assignments	status-report

Writing Flow

1. Identify document type and topic
2. Read style-guide.md for style rules
3. Read the matching templates/<type>.md for structure
4. Generate content following the template
5. Self-check against the style guide checklist

Key Style Quick Reference

• Section headers use ## with bold: ## **Core Output:**
• Data changes use bold with delta: accuracy improved from 82.9 to **86.09 (+3.19)**
• Tables are the primary communication tool, not decoration
• Each experiment/optimization step gets its own number with clear before/after comparison
• Every document ends with Action Items or TODO
• Technical terms stay in English: SFT, CPT, RAG, LLM-as-judge, embedding
• No filler, no fluff — every sentence carries data or a decision