L12 Oss Docs Project

title: "Open Source Documentation — Complete Project" weight: 12 description: "Apply everything you learned about open source documentation: create or improve README, contributing guide, code of conduct, changelog, and templates for a complete project documentation set." date: 2026-06-28 lastmod: 2026-06-28 tags: [technical-writing, open-source] }

The open source documentation project applies every skill from this course: creating or improving all essential documentation files for an open source project to drive adoption and contribution.

In this lesson, you will combine all previous lessons into a single project producing a complete documentation set.

What You'll Learn

You will apply README writing, contributing guide creation, code of conduct adoption, changelog formatting, and template creation for a complete project.

Why It Matters

Theory without practice is worthless. This project produces a documentation set that directly improves an open source project.

Project Steps

Step 1: Select a Project

Choose an open source project you use, maintain, or want to improve.

Step 2: Audit Existing Documentation

Evaluate what exists and what is missing.

Step 3: Create or Improve Files

• README
• CONTRIBUTING.md
• CODE_OF_CONDUCT.md
• CHANGELOG.md
• Issue templates
• PR template

Step 4: Submit as Pull Request

Contribute your improvements back to the project.

Teacher Mindset

This project makes a real impact. You are not creating throwaway exercises. You are improving documentation that real developers use.

Common Mistakes

1. Changing Too Much at Once

Submit focused PRs. One PR per file or improvement.

2. Not Following Project Patterns

Match the existing style and tone of the project.

3. Submitting Without Discussion

For significant changes, open an issue first to discuss.

FAQ

Mini Project

This lesson is the mini project. Complete all steps and submit your improvements. Write a retrospective on the experience.

What's Next