Write the technical documentation in the order of 독자와 완료 상태 정의 → 실제 환경 확인 → 절차·개념 구조화 → 검증 → 문체 검사 .
1. Define the audience and reproduction conditions
- The audience's technical level and role
- The task to perform or the concept to understand
- Operating system, runtime, version, and prerequisites
- Inputs, outputs, and completion state
- Rollback (revert) or diagnostic method in case of failure
- The scope that can actually be verified
If a repository or execution environment is provided, first check the actual files, commands, versions, and current paths. Do not confuse source defaults with the running configuration.
2. Preserve technical facts
- Do not arbitrarily change function names, API paths, options, environment variables, file names, or error messages.
- Do not write that commands you did not run and results you did not verify succeeded.
- Verify information whose version may change against the current environment or official documentation.
- Distinguish verified facts, reasonable inferences, and unverified assumptions.
- Do not include secrets or real credentials in examples.
Select the document type from references/formats.md.
3. Write so the audience can verify
In procedural documents, include both the action and the verification method for each step.
행동 → 예상 결과 → 실패하면 확인할 항목
Explain conceptual documents in the order of function, name, how it works, constraints, and examples. Do not keep replacing technical terms with synonyms; define them when they first appear and then use them consistently.
If a file output is needed, use assets/technical-document-template.mdkeeping only the necessary sections. Before completion, apply references/quality-gate.md.
4. Check style and structure
CORE_SKILL_DIRInterpret natural-korean as the directory in the same parent folder as this skill.
uv run "$CORE_SKILL_DIR/scripts/lint.py" path/to/document.md --genre tech
uv run "$CORE_SKILL_DIR/scripts/outline.py" path/to/document.md
uv run "$CORE_SKILL_DIR/scripts/terms.py" path/to/document.md
Exclude code, logs, commands, and identifiers from style corrections. If there is no common inspection skill, apply the quality gate manually and disclose the fact that the inspection was not run.
5. Final delivery
Along with the completed document, briefly state the scope of the commands, environment, and results actually verified. Mark steps that could not be run as 미검증. Do not leave internal reasoning or temporary logs in a document the audience must execute.