Technical Writing

Contents

• Motivation
• Article types
• Highlights
• Methodology
• Q & A

Motivation

• Personal marketing
• Know-how transfer
• Opportunity for self learning
• Organizational or personal documentation
• Easier than presentation to express yourself

Article types

• New technology announcement
  • E.g: npm package
• Trouble shooting
• Common problem solving
• Case study
• Technology comparison
• Technology review (pros and cons)
• Literature survey

Highlights

• Writing existing topics again and again is not recommended
• 1 to 1 translation is not a good content
• Writer should confident about their content is good for reading
• Supporting materials
  • Images
  • Code blocks
  • Sandbox, repository or deployed instance
• Not include company's code into it, paraphrase if needed
• Personal experiences are important
• Add why and how, if you're insisting to write tutorial

Methodology

• Starting point
  • Problem you solved in project
  • Concept to learn and deep dive
• Search and be sure about it's not written
• Summary or combination of multiple resources is an option (literature survey)
• Add supporting materials
• Send someone to review
• Be open for feedbacks and improvements
• Publish
• Interact with readers through comments (optional)

??? Q & A ???

Thank you for listening