Welcome to my Technical Writing Portfolio.
This repository showcases my ability to create clear, structured, and professional documentation in multiple formats (Markdown, DITA/XML, HTML, PDF).
- Format: Knowledge Base article
- Skills: Concise instructions, troubleshooting, security notes
- File: KB_reset_pw_FINAL.md
- DITA version: KB_reset_pw_FINAL.dita
- Format: Quick Start / How-To article
- Skills: Installation steps, command-line examples, screenshots
- File: MKDocs_guide.md
- DITA version: MKDocs_quickstart_task.dita
- Format: API Reference document
- Skills: Base URL, endpoints, parameters table, example request/response, status codes
- File: API_doc_openmeteo.md
- DITA version: API_doc_openmeteo.dita
- Format: End-user manual with screenshots
- Skills: Task creation, editing, deleting, troubleshooting, features overview
- File: MS_Todo_UserManual.md
- DITA version: MS_Todo_UserManual.dita
- Markdown → Readable, GitHub-friendly documentation
- DITA/XML → Industry-standard structured authoring
- DITA-OT → Builds HTML and PDF outputs
- Screenshots → Visual guidance for end-users
Technical_Writting_Portfolio/
│
├── API/
│ ├── API_doc_openmeteo.md
│ └── API_doc_openmeteo.dita
│
├── KB/
│ ├── KB_reset_pw_FINAL.md
│ └── KB_reset_pw_FINAL.dita
│
├── QSG/
│ ├── MKDocs_guide.md
│ └── MKDocs_quickstart_task.dita
│
├── UManual/
│ ├── MS_Todo_UserManual.md
│ └── MS_Todo_UserManual.dita
│
├── portfolio.ditamap
└── README.md ← (You are here)
- Author: Saumil Khanna
- Email: saumilkhanna@gmail.com
- LinkedIn: linkedin.com/in/saumilkhanna
- GitHub: github.com/saumilkhanna