Welcome to My Technical Documentation Portfolio
Welcome! This is a personal documentation site created as part of my journey to become a professional Technical Writer.
The goal of this site is to demonstrate my understanding of technical writing principles using modern documentation tools and practices, especially the Docs-as-Code approach.
📚 What You’ll Find Here
This site contains structured, beginner-friendly documentation created using MkDocs — a powerful static site generator for technical documentation.
Here are the main sections you can explore:
-
About MKDocs
Understand the purpose of this project and discover how MkDocs simplifies the process of building modern, user-friendly documentation websites. -
Installation Tutorial
Step-by-step guide on how to install MkDocs on your local machine. -
Usage Guide
Learn how to preview, manage, and improve documentation using MkDocs — from basic setup to advanced customization.
🛠️ Tools and Technologies Used
- MkDocs — for generating static documentation sites
- Markdown — for writing clean, readable content
- Visual Studio Code — as a code and content editor
- Git & GitHub — for version control and publishing
- Material for MkDocs — for professional UI and features
👤 About Me
My name is Bahrul ! I'm an aspiring technical writer with a strong interest in documentation, developer experience, and open source collaboration. This portfolio is an example of my ability to structure and deliver clear, useful documentation for real-world tools.
📎 Start Exploring
👉 If you’re new, begin with the Installation Tutorial.
👉 Already installed? Go to the Usage Guide.
Thank you for visiting!