Technical Writing: How to Write Software Documentation
5.0 /5- Offered byUDEMY
Technical Writing: How to Write Software Documentation at UDEMY Overview
Duration | 12 hours |
Total fee | ₹3,499 |
Mode of learning | Online |
Credential | Certificate |
Technical Writing: How to Write Software Documentation at UDEMY Highlights
- Earn a Certificate of completion from Udemy
- Get a 30 days money back guarantee on the course
- Get full lifetime access of the course material
- Learn from 9 articles and 14 downloadable resources
- CNBC cited this course in the article about "The 20 hottest job skills companies are looking for right now"
Technical Writing: How to Write Software Documentation at UDEMY Course details
- Learn what is required to start working on the software documentation for an app
- Learn how to write documentation in GitHub Wiki using Markdown
- Try out tools and infrastructure that helps you immediately get started writing your help content
- Learn how to prepare, structure and develop information that help users use your software
- Learn the basics of structured writing
- In the course of the years, the core activities of technical writing professionals have been constantly evolving
- Participants need to bundle together the writing skills, design and graphics, video creation, multimedia, metadata, and software development to meet the expectations of our users
- By the end of this course, students will know how to get started writing their user guides, which best practices and rules to consider, which tools to use for writing
Technical Writing: How to Write Software Documentation at UDEMY Curriculum
Documentation in the Software Development World
Technical Writer in the Software Development Team
The Technical Writing Process
Exercise
The Ultimate Purpose of the Technical Writer
Writing Software Documentation in GitHub using Markdown
Writing Documentation Using GitHub Wiki
Overview - Sample Setup in GitHub
What is GitHub?
Why Writing in GitHub?
Documentation in GitHub
Markup Language in Wiki Pages
Instructor Examples in GitHub
Style Guide in Technical Writing (or Standards and Guidelines for Writing Docu)
How to Use a Style Guide in Technical Writing
What is Style Guide?
Why do we Needs Standards for Writing?
Sample Style Guides
3 Sample Style Guides
Who Else Needs Rules for Writing?
Introduction to Structured Writing
Structured Writing
Why Do We Need Structure in Writing?
Organizing Large Amounts of Content
Consistency in User Experience
Intuitive and Obvious User Experience
Ensuring Completeness of the Documentation
Targeting Content to Various Audiences
The 12 Principles of Technical Writing
Principles of Technical Writing
Principle #1: Decide Who are You Writing For
Principle #2: Identify the Information Needs
Principle #3: Decide on the Style
Principle #4: Decide Which Deliverables to Create
Principle #5: Decide Which Tools to Use
Principle #6: Define the Content Structure
Software Documentation Development using DITA XML in Oxygen Author
What is DITA?
Who Defines DITA?
The DITA Specification
Overview of the Specification
Do You Need to Know the Specification by Heart?
Basics of Structured Writing
Technical Writing: How to Write Software Documentation at UDEMY Faculty details
Other courses offered by UDEMY
Student Forum
Anything you would want to ask experts?