Tag: technical-writing
13 articles tagged technical-writing.
- Content creation
The technical writer creates the content of the technical writing project in constant dialogue with the company's various players: R&D departments, marketing.
- Delivery
Explore the documentation delivery phase: choosing the right output format (PDF, HTML, EPUB), managing the publishing workflow, and validating the final deliverable.
- Formats and tools
When industrializing technical writing, the format matters more than the tool. Compare Word, Markdown, reStructuredText, DITA XML, and DocBook to find the right fit.
- From technical writing to technical communication
Technical communication is often reduced to technical writing. Technical writing is intended to provide product documentation, and is involved downstream of sales.
- Gathering information
How technical writers gather information: expert interviews, product testing, existing documentation, and field observations to build accurate and useful content.
- Is an index useful in a PDF?
Is an index still useful in a PDF manual in the age of full-text search? Explore the pros and cons for technical documentation and help content usability.
- KISS Principle of Simplicity
The KISS principle (Keep it simple stupid) is a general engineering principle that advocates simplicity to improve reliability, maintenance and scalability.
- Project definition
Define your technical documentation project before writing: identify the audience, scope, deliverables, and success criteria to guide the entire editorial process.
- Source format
Word processors have unaccustomed us to distinguishing between form and content. But confusing the two leads to many errors and wasted time.
- Target format
The target format is the format end users consume: PDF, HTML, EPUB, or online help. Learn how to choose the right documentation output format for your audience.
- Testing products to document them
A technical writer must test the product before documenting it. Explore hands-on product discovery methods, expert interviews, and techniques to ensure documentation accuracy.
- The three levels of technical documentation
Compare the three maturity levels of technical documentation — from informal notes to modular structured content — and find where your organization stands today.
- Validation and quality control
Discover quality control and validation processes for technical documentation: review cycles, style guides, terminology checks, and delivery gates before publication.