Build or Contribute to Documentation with a Git-based Workflow from Pluralsight

Read the Docs is a great documentation platform used by many open source projects. This course teaches you how to create your own documentation project, use the reStructuredText markup language, and the basics of Git-based workflow for pull requests.

Documentation of software applications and packages is often an afterthought at best, and frequently forgotten altogether. Putting together some good, easy-to-navigate documentation that can be updated by the community in a controlled fashion can really help avoid questions and make your application or package easier to use. In this course, Build or Contribute to Documentation with a Git-based Workflow, you'll explore a couple of options available to you, and then go into a full solution using Read the Docs by creating a documentation project. First, you'll learn about the reStructuredText syntax for some of the key elements you’ll likely want to include in your documentation. Then, you’ll delve into setting up a CI/CD workflow by putting your documentation in GitHub and show the standard workflow for pull requests. Additionally, you'll discover how to customize the look of your documentation, use Markdown, and have different versions of your documentation. Finally, you'll explore self-hosting documentation and code in the event that a Read the Docs hosted site is not a good option for you. By the end of this course, you'll have the necessary knowledge to efficiently create your own documentation projects, contribute to open source documentation, make pull requests, and know the hosting options available to you.

What's inside

Syllabus

Course Overview

Free up Your Time or Give a Little Back: A Case for Documentation

Getting Started: Create Your Documentation Project

Leveraging the Power of reStructuredText Markup

Automating Updates with a Streamlined Workflow

Content That Goes Beyond reStructuredText

Hosting Alternatives for the Documentation and Its Source

Good to know

Know what's good

, what to watch for

, and possible dealbreakers

Meant for self-study and to help learners contribute directly to open source projects

Develops a strong knowledge of documentation fundamentals and best practices

Taught by Erik Dahl, a recognized expert in documentation and open source

Teaches the reStructuredText markup language, an industry standard for documentation

Provides options for hosting the documentation, ensuring accessibility and security

Hands-on practice with a Git-based workflow for pull requests, an essential skill for open source contributions

Activities

Be better prepared before your course. Deepen your understanding during and after it. Supplement your coursework and achieve mastery of the topics covered in Build or Contribute to Documentation with a Git-based Workflow with these activities:

Follow a tutorial on using Git for version control

Show steps

Following a tutorial on Git will help you understand how to use the version control system effectively.

Browse courses on Git

Show steps

Find a tutorial on using Git.
Follow the tutorial and complete the exercises.
Use Git to track changes to your documentation project.

Practice writing reStructuredText

Show steps

Practicing writing reStructuredText will help you become more proficient in using the markup language.

Show steps

Find some example reStructuredText documents online.
Write your own reStructuredText document.
Get feedback on your reStructuredText document from others.

Review the Read the Docs documentation

Show steps

Review the Read the Docs user guide to familiarize yourself with the platform and its features.

View Life; v.18 JY-D(1891) on Amazon

Show steps

Visit the Read the Docs website and browse the documentation.
Create a free account and explore the features available to you.
Read through the user guide to understand how to use Read the Docs.

Five other activities

Expand to see all activities and additional details

Show all eight activities

Create a documentation style guide for your team

Show steps

Creating a documentation style guide will help ensure consistency and quality in your team's documentation.

Browse courses on Documentation

Show steps

Gather input from your team on their documentation needs.
Research best practices for documentation style.
Create a style guide that includes guidelines for formatting, tone, and content.
Share the style guide with your team and get feedback.

Create a documentation project for a simple open source software

Show steps

Creating a documentation project will help you apply the concepts learned in the course to a real-world scenario.

Browse courses on Documentation

Show steps

Choose a simple open source software project that you are familiar with.
Create a documentation project for the software using Read the Docs.
Write documentation for the software using reStructuredText.
Create a pull request to contribute your documentation to the software project.

Volunteer to document an open source software project

Show steps

Volunteering to document an open source software project will give you hands-on experience and help you contribute to the community.

Browse courses on Documentation

Show steps

Find an open source software project that needs documentation.
Contact the project maintainers and offer your help.
Create or update documentation for the software project.

Write a blog post about your experience using Read the Docs

Show steps

Writing a blog post will help you reflect on your experience and share your knowledge with others.

Browse courses on Documentation

Show steps

Choose a topic related to Read the Docs and documentation.
Write a blog post that shares your experiences and insights.
Publish your blog post and share it with others.

Attend a meetup or conference on documentation

Show steps

Attending a meetup or conference on documentation will allow you to network with other professionals in the field.

Browse courses on Documentation

Show steps

Find a meetup or conference on documentation.
Attend the event and meet other professionals.
Share your knowledge and learn from others.

Career center

Learners who complete Build or Contribute to Documentation with a Git-based Workflow will develop knowledge and skills that may be useful to these careers:

Technical Writer

Technical writers craft user guides, instruction manuals, documentation, and training materials that explain the use and features of various products and services. This course can help you to develop this skillset through hands-on experience with a Git-based workflow and reStructuredText markup, both commonly used by technical writers. Additionally, this course may enhance your understanding of the wider field including documentation and content organization for online platforms.

See salaries and explore the career path for Technical Writer

Software Developer

Software developers build and maintain computer software for various platforms and applications. This course can help you learn the fundamentals of documentation for software applications and packages, a valuable skill for any software developer.

See salaries and explore the career path for Software Developer

Systems Engineer

Systems engineers design and implement complex systems, integrating hardware and software components. This course can help you build a foundation in documentation and communication skills, essential for success in this role.

See salaries and explore the career path for Systems Engineer

Project Manager

Project managers oversee and coordinate projects from initiation to completion. This course can help you develop essential documentation and communication skills, which are crucial for effective project management.

See salaries and explore the career path for Project Manager

UX Writer

UX writers craft clear and concise content for user interfaces, ensuring a seamless user experience. This course may help you develop your skills in documentation and content organization for online platforms.

See salaries and explore the career path for UX Writer

Technical Support Specialist

Technical support specialists provide technical assistance to users of software applications and products. This course can help you build a foundation in documentation and communication skills, essential for providing effective technical support.

See salaries and explore the career path for Technical Support Specialist

Content Strategist

Content strategists plan, develop, and manage content for various platforms and channels. This course may help you develop your skills in documentation and content organization for online platforms.

See salaries and explore the career path for Content Strategist

Database Administrator

Database administrators manage and maintain databases, ensuring data integrity and accessibility. This course can help you build a foundation in documentation and communication skills, essential for effective database management.

See salaries and explore the career path for Database Administrator

Product Manager

Product managers define and oversee the development of products from concept to launch. This course may help you develop your skills in documentation and content organization for online platforms, essential for effective product management.

See salaries and explore the career path for Product Manager

Information Architect

Information architects design and organize information systems and structures. This course may help you develop your skills in documentation and content organization for online platforms, essential for effective information architecture.

See salaries and explore the career path for Information Architect

Technical Communicator

Technical communicators develop and deliver technical information to various audiences. This course can help you build a foundation in documentation and communication skills, essential for effective technical communication.

See salaries and explore the career path for Technical Communicator

Software Tester

Software testers evaluate software applications and products to identify and report defects. This course can help you build a foundation in documentation and communication skills, essential for effective software testing.

See salaries and explore the career path for Software Tester

User Experience Researcher

User experience researchers conduct research to understand user needs and behaviors to improve product design and usability. This course may help you develop your skills in documentation and content organization for online platforms, essential for effective user experience research.

See salaries and explore the career path for User Experience Researcher

Instructional Designer

Instructional designers create and develop educational materials and programs. This course can help you build a foundation in documentation and communication skills, essential for effective instructional design.

See salaries and explore the career path for Instructional Designer

Content Writer

Content writers create and develop content for various platforms and channels. This course may help you develop your skills in documentation and content organization for online platforms.

See salaries and explore the career path for Content Writer