Creating Technical Documentation with GitHub

1h 11mIntermediate2025-02-28

Authors

Michael Fawole

Course details

GitHub is an excellent repository for code, but it also supports a wide variety of tools for creating documentation. Creating documentation is more intricate than extracting comments from code, and GitHub provides explicit support for tools that help writers scaffold, enrich, and manage text. In this course, Michael Fawole shares practical skills to elevate your documentation process and drive team efficiency—by treating documentation like code. Learn how to create and manage content with the same framework that developers use daily.

Learning objectives
Understand the principles and methodologies of treating documentation as code. This includes learning how to integrate documentation workflows with software development practices.
Build and collaborate on technical content projects with development environments and version control.
Manage technical writers and developers with the same workflow.

Skills covered

Enterprise Content ManagementVersion ControlGitHubSoftware Development ToolsNetwork and System AdministrationSoftware DevelopmentOne-Off

Concepts

0. Introduction

01 - Getting with technical documentation in GitHub

1. Treating Documentation as Code

02 - What is docs as code
03 - Benefits of docs as code
04 - Common problems with traditional documentation

2. Tools and Technologies

05 - Git basics for documentation
06 - Installation of Git
07 - Setting up a repository
08 - Markdown editors
09 - Version control for documentation
10 - Branching and merging strategies

3. Writing Documentation as Code

11 - Basic syntax and features in Markdown
12 - Advanced Markdown techniques
13 - Naming conventions - Part 1
14 - Naming conventions - Part 2
15 - Creating an index or table of contents
16 - Invitation to try what you learned

4. Collaboration and Review Processes

17 - Pull requests and code reviews
18 - Best practices for collaborative documentation

5. Deployment

19 - Converting docs to HTML file
20 - Deployment to Vercel

Conclusion

21 - Next steps