Technical Writing: How to Write Software Documentation

Become a Technical Writer: Master Software Documentation & Launch Your Career

Are you frustrated with spending countless hours explaining how to use your software? Do you receive feedback that your documentation is confusing or difficult to follow? This practical, hands-on course will equip you with the skills to create clear, effective software documentation that your customers will love.

Featured in CNBC's "20 Hottest Job Skills," this course is designed for beginners and will guide you through the entire technical writing process, even if you have no prior experience.

What You'll Learn:

• Foundations of Technical Writing: Understand the core principles, terminology, and deliverables of technical writing in the software industry.
• Writing Software Documentation with GitHub Wiki: Learn to create and manage documentation using GitHub's Wiki, a crucial skill for showcasing your abilities and building your portfolio.
• Visual Communication: Create engaging instructional images and graphics using Canva to enhance your documentation.
• Information Architecture: Discover the fundamentals of information architecture and how to apply user research techniques like Card Sorting in Mural to structure your documentation effectively.
• Quality Assurance: Learn to define and measure quality in documentation, ensuring your content is accurate, helpful, and user-friendly.
• Practical Tools & Techniques: Get hands-on experience with the GitHub Wiki editor and Canva, and discover other essential tools for technical writers.
• User Research: Conduct effective user research using Card Sorting techniques to understand your audience's needs.
• Documentation Best Practices: Learn the core principles for writing software documentation that truly helps users.
• Portfolio Building: Develop a portfolio of work samples to showcase your skills to potential employers.

Course Breakdown:

• Section 1: Getting Started with Technical Writing (1 hour): An introductory overview of technical writing, deliverables, and the documentation creation process. (Free Mini-Course!)
• Section 2: Writing Software Documentation in GitHub using Markdown (2+ hours): Learn to set up a GitHub Wiki, master Markdown syntax, and create tables, images, and tables of contents.
• Section 3: Graphics in Software Documentation (40 min): Discover the importance of visuals in documentation and learn how to create effective infographics using Canva.
• Section 4: Information Architecture Basics (1+ hour): Explore the fundamentals of information architecture and how to conduct user research using Card Sorting in Mural.
• Section 5: Quality in Software Documentation (40+ min): Understand the characteristics of high-quality documentation and learn how to measure and improve your content.
• Bonus Section: Additional Webinars (3+ hours): Access recorded live webinars with the instructor and fellow students for deeper dives into key topics.

Who is this course for?

• Beginners interested in a career in technical writing.
• IT students looking to gain practical skills.
• Developers seeking to improve their documentation skills.
• Anyone who wants to create clear, effective documentation for software products.

What's NOT covered:

• In-depth API documentation (check out our dedicated course!)
• Writing in English (focus is on tools and techniques)
• Detailed MS Word usage
• Writing books or unstructured documentation

Time Commitment:

• Section 1: 1-2 hours
• Section 2: 2-4 hours
• Section 3: 1-2 hours
• Section 4: 1 hour
• Section 5: 40+ minutes
• Bonus: 3+ hours

Instructor: Jordan Stanchev, a User Assistance Development Architect with years of experience training technical writers.

Student Testimonials:

"Jordan's course is perfectly structured and provides practical skills with easy-to-follow instructions." - Karina Delcheva, Technical Writer

"This course put me in the right direction for a technical communicator role. The instructor's expertise and hands-on activities are invaluable." - Grace Tan, Technical Writer

Ready to launch your technical writing career? Enroll today and take advantage of our 30-day, no-questions-asked refund policy!