Technical Writing

Technical writing

Write for the reader's task and background. Follow the repository's document template and terminology.

Choose a structure that serves the purpose: a tutorial teaches through a worked example, a how-to solves a task, reference supports lookup, and explanation develops understanding. Combine or link sections when that helps the reader; a short PR description does not need this classification exercise.

• Lead with the result, problem, or action the reader needs.
• Use real symbols, commands, and paths. Keep names consistent.
• Give instructions as commands, with relevant conditions before the action.
• Prefer concrete language and active verbs. Preserve necessary qualifications.
• Use examples, tables, or diagrams only when they clarify something prose would make harder.
• Match code formatting to the project. Do not impose global punctuation, indentation, or sentence-length rules.
• State the validation actually performed and the limits of the evidence.

Edit directly for clarity. No mandatory second skill pass or expansion of a shared banned-word list is needed.