Mackenzie.TechDocs

Welcome to my technical documentation portfolio. This repository showcases samples of my work as I participate in the Technical Writing Mentorship Program.

About This Repository

This portfolio demonstrates my ability to create clear, user-focused documentation across various formats:

• API Documentation - RESTful API references with endpoint descriptions and examples
• How-To Guides - Step-by-step tutorials for common tasks
• Configuration Manuals - System setup and configuration instructions
• White Papers - Technical analysis and best practices documentation
• Quick Reference Guides - Concise reference materials for developers

Technical Writing Mentorship Program

Through this program, I am developing skills in:

• Documentation architecture and information design
• Technical accuracy and clarity
• Audience analysis and content strategy
• Documentation tooling and workflows

This repository will be updated regularly as I complete new projects and refine my documentation samples.

Code Examples

Documentation samples include properly formatted code blocks:

print(f"Hello World!")

{
    "itemName": {
        "gilgamesh": "fruit",
        "midgarsommr": "vegetable",
        "chocobo": "sugar",
        "Famfrit": "steak",
        "aether": "grain"
    }
}

Learn More

• GitHub: github.com/mso-docs
• Portfolio: mackenziesobrien.com