Technical

I am only charging for my time if you would like to learn anything from the course below.

Overview Technical Writing

• Understanding the role of a technical writer
• Overview of different types of technical documents
• Introduction to style guides and documentation standards
• Realtime documentation
• DDLC/SDLC

How Documentation work

• Conducting audience analysis and needs assessment.
• Gathering information from subject matter experts (SMEs)
• Conducting effective research and organizing your findings
• Writing clear and concise sentences
• Using active voice and avoiding jargon
• Applying principles of readability and accessibility
• Editing and proofreading techniques
• Choosing appropriate fonts, colors, and layout styles
• Using templates and style guides consistently
• Formatting tables, lists, and other visual elements
• Creating user-friendly documentation for digital platforms
• Release Notes

Tools

• Demonstration of 1 of the Authoring tool
• FrameMaker
• SnagiT
• JIRA
• Agile
• XML
• KnowledgeOwl
• Confluence
• Visual studio code
• Microsoft Word
• Postman
• Github

Specialized Technical Writing

• Writing user manuals and installation guides
• Creating API documentation and developer guides
• Tips for writing effective release notes and FAQs

Interview specific Q&A

• Basic questions that an interviewer expect.

Assignment

• Assignment review and feedback

Package

The session will be conducted through Topmate. Charges will be applicable based on the duration you purchase:

• 500 for a 30-minute session
• 1000 for a 1-hour session

Note: This course will be completed in approximately 8 hours. The duration may vary according to the student.