Technical communication helps people find and use information about a technical product. Technical documentation is commonly organized by feature or product so a developer can answer a specific question. That differs from technical training, which teaches someone how to build something through a sequence of instructions. Both require research, but they serve different goals. section 2.1.5
To get started with technical documentation:
- Take a technical writing course, then read documentation and articles to learn how others structure their explanations. section 5.5.3
- Follow a style guide for decisions such as heading capitalization, introductions, and summaries. section 5.5.3
- Decide whether the document explains a process or answers one question. Leave out details that distract from its purpose. section 5.5.3
- Before publishing, step away and return to proofread for wording, unnecessary material, and missing information. section 5.5.3
Answer the question being asked
If someone searches for how to center a div in HTML, give them the code they need rather than a long detour. A focused answer makes the information easier to find and use. section 5.5.3
