Technical Writing Examples ✍️

This repository showcases revised README files created as part of the Technical Writing class at ALGOSUP. Explore the examples to learn best practices in writing clear, user-friendly, and professional README files.

📚 Table of Contents

Example Name	Link
Apache Open Office 2.4	Revised README
Symantec	Revised README

📁 Repository Structure

• apache-openoffice/ – Revised README for OpenOffice 2.4
• symantec/ – Revised README for a Symantec product
• (More coming soon!)

🧭 How to Use These Examples

• 💡 Use them as inspiration for writing your own README files.
• 🔍 Compare revised versions with original (if available).
• ✍️ Practice restructuring and rewriting real-world documentation.

🎯 Learning Objectives

By reading and analyzing these examples, you will:

• Understand the anatomy of a great README.
• Learn how to explain technical concepts clearly.
• Improve your formatting, accessibility, and consistency in writing.

🙌 Contribute Your README

Are you a student in the class?
You can contribute your revised README example to this repository:

1. Fork the repository.
2. Create a folder for your project.
3. Add your revised README.md.
4. Submit a pull request!

Let’s build a helpful library of README examples together!

🧑‍🏫 Maintainer

Created and maintained by Antoine Prevost for the ALGOSUP Technical Writing course.