tech-docs
Language-neutral documentation standard - doc set (README, architecture with Overview, concepts, domain, decision records), reading tiers that keep context small, architecture as a contract, contract doc comments on every item, Related links by meaning or dependency (never usages), Sync pairs, why-comments with tags, large-file sections, Impact search before edits, Sync check before done. Load whenever code, comments, or docs are in scope (every plan, implement, review, docs-repair).
- License 许可
- MIT
- 最近更新
- 2026-11-11
- Stars
- ★ 3
- Forks
- 0
01 前言 Front Matter
- name
- tech-docs
- description
- Language-neutral documentation standard - doc set (README, architecture with Overview, concepts, domain, decision records), reading tiers that keep context small, architecture as a contract, contract doc comments on every item, Related links by meaning or dependency (never usages), Sync pairs, why-comments with tags, large-file sections, Impact search before edits, Sync check before done. Load whenever code, comments, or docs are in scope (every plan, implement, review, docs-repair).
03 SKILL.md 正文
Read and apply .github/skills/tech-docs.md exactly. Details for Section 4.6 in .github/copilot-instructions.md.
04 同仓库更多 Skills
workflow-review
Skeptical auditor review. Answer ready-for-public-release for the scope. Summary is a findings table plus a hunt-results table. Ignore prior reviews unless named. Load skills from the Section 3 table. Locked finding How. Default runs tests; static on explicit reduced scope. Use on /review.
workflow-review-loop
Review and remediate in a loop until findings are resolved. Use on /review-loop or when user wants review+fix cycles without a plan.
workflow-requirements
Record an atomic, contradiction-free requirement list as REQ-<AREA>-<TOPIC> (shall / shall not / shall exhibit). The ID names the subject. Context prose gets no ID. Implementation-far. Use on /requirements, or before /plan when none exist. Use existing artifacts when the user already supplied them.
workflow-port-dotnet-rust
Port a .NET/C# solution to Rust as a complete, content-equivalent port. Phase 0 intake and machine inventory, Phase 1 human alignment into port/MANIFEST.md, Phase 2 autonomous loop, Phase 3 closing audit. Full books: every public member, behavior item, and .NET test booked with a closed status set. Use on /port-dotnet-rust, when porting .NET or C# to Rust, or when port/** is in scope.
workflow-port-dotnet-rust-loop
Autonomous .NET → Rust port loop. Requires an approved port/MANIFEST.md. Ports one unit per iteration completely (tests first, implement, verify, equivalence hunt), keeps the books in port/ balanced, books questions as blockers instead of asking, and resumes from port/STATUS.md. Use on /port-dotnet-rust-loop or to continue a port.
workflow-plan
Create an implementation plan with locked How, Before/After, schematic API and interface snippets before the steps, first-class TEST-<AREA>-<TOPIC> content, linked requirements (no copied requirement list), and step acceptance. Run requirements first when none exist. Close with a requirements walk and a conversation walk. Use on /plan or before implementation without an approved plan.