- Solve a problem
- Address a specific Audience
- Layout and structure are used to increase readability.
- It helps making well-informed decisions.
- It reduced risks and prevents accidents.
- It saves money by reducing support request.
- It helps users use and recommend a product.
- It enhances product quality.
- It pushes scientific progress by helping us comprehend technical processes.
- Any Engineer can do it
- The person need to have 360 degree knowledge of the topic
- Any Writer can do it
- There is a certain way to write Technical writings.
- Technical writing is writing
- No, research, communication are required.
- People want to read writing
- Do not use GIFs or Emojis
- Correct, Honest, Tone, Proof read
- Include necessary info
- Level details
- Readability and scan-ability
- Logical chunks organisation
- Clear structure/layout
- Give tags, links, references
- Simple language
- Use graph, image, map
- Active voice
- Short simple terms
- Remove unnecessary info
- Do not repeat texts
- Consistent naming system
- Follow an SOP
- Do not mix active, passive while addressing audience
- Do not vary tones
- Information collecting and drafting
- Revising and Editing
- Proofreading and Testing
- Research skills
- Interview SMEs
- Run surveys
- User tests
- How to interview Subject Matter Experts (SMEs)
- How to interview different user groups
- How to design and conduct user tests
- How to design and run surveys
- How to analyze primary data
- How to analyze secondary data
- Writing skills
- How to write correctly
- How to write clearly
- How to write efficiently
- How to write user-centered
- Inter-personal skills
- How to ask experts and users for certain information
- How to ask stakeholders for their expectations
- How to translate user needs, experience and knowledge into writing
- Learning skills
- How to fully understand products and processes
- How to analyze, structure, and make sense of data
- How to learn and apply new terminology
- How to improve your various (writing, research, technical) skills continuously
- How to be open for criticism
- Your purpose is poorly defined.
- Your audience is poorly defined.
- You write for yourself, not your audience.
- You use lengthy sentences.
- You use complicated words.
- Your page layout lacks structure.
- You use inconsistent naming.
- Your document contains useless information.
- There are too many authors working on your text.
- You use the wrong writing tool.
- You don't research.
- Your don't test.
- Show authentic interest in your audience.
- No writing without research.
- Collaborate wisely!
- Invest time (and money) in the right tool.
- Work on improving your skills.
- Treat the writing of your doc like a project.
- Treat your document like a product.
- dTest and improve continuously.
Technical Writing by Google
Gales, C. et al (2020): The Product is Docs.G.J. Alred, C.T. Brusaw, W.E. Oliu (2011): Handbook of Technical Writing, 10th Edition. P. V. Anderson (2017): Technical Communication, 9th Edition. Van Laan, K., Hackos, J.T. (2012): The Insider’s Guide to Technical Writing.
Articles & Blog Posts
Contentwriters.com: What is Technical Writing? https://contentwriters.com/blog/what-is-technical-writing/ Instructional Solutions: What is Technical Writing? https://www.instructionalsolutions.com/blog/what-is-technical-writing
FFeathers, Blog: https://ffeathers.wordpress.comI’d rather be writing, Blog: https://idratherbewriting.comOnline Technical Writing: https://www.prismnet.com/~hcexres/textbook/
Technical Communication Quarterly:
Journal of Technical Writing and Communication:
Amruta Ranade, Youtube Channel: https://www.youtube.com/channel/UCKsaZMjb3lsLe5YtasDifuA
Associations & Forums
Society for Technical Communication: http://www.stc.orgEServer Technical Communication Library: http://tc.eserver.org/
Documentation & Technical Writing LinkedIn Forum: https://www.linkedin.com/groups/2632674/