This repository showcases my technical writing portfolio, demonstrating my ability to create clear, concise, and user-friendly documentation. It includes a portfolio website built from scratch and a collection of live documentation samples.
- Explore my portfolio website: pvega62.github.io/portfolio
- View my documentation samples: github.com/pvega62/Portfolio/wiki
I employ a modern, docs-as-code approach to documentation, which includes the following tools and practices:
- Authoring: Markdown in VS Code
- Version Control: Git / GitHub
- Style & Grammar: Vale
- API Documentation: Postman, Swagger/OpenAPI, JSON
- Publishing: GitHub Wikis, GitHub Pages
I structured this site to provide a clear and logical path for users to explore my work, with a focus on easy navigation and scannability.
├── /
│ ├── index.html
│ ├── aboutme.html
│ ├── articlesandessays.html
│ ├── technical-writing-hardware.html
│ ├── technical-writing-software.html
│ ├── uxwriting.html
│ ├── raw-markdown.html
│ ├── Pedro Vega Resume.pdf
│ ├── css/
│ ├── js/
│ ├── fonts/
│ ├── images/
│ ├── samples/
│ └── styles/
└── /wiki
├── Home.md
├── Pet-Store-API-Documentation-Sample.md
├── Stripe-API-Documentation-Sample.md
├── Using-Postman-to-Connect-to-the-Stripe-API.md
└── ... (and other documentation samples)
I have experience crafting user-centric microcopy that enhances user experience and drives engagement. My UX writing samples can be found in the UX Writing section of my portfolio website.
My content strategy for this portfolio is to showcase a diverse range of my writing and technical skills, while tailoring the presentation for different audiences.
- For Recruiters: The README file provides a high-level overview of my skills and accomplishments, with clear links to my live portfolio and documentation samples. The structure is designed to be scannable.
- For Developers: The documentation samples in the
/wikidirectory are written in a clear, concise, and developer-focused style. They include code samples, API references, and other technical details that are relevant to a developer audience.
This multi-layered approach ensures all visitors to this repository can find the most relevant information.
- Authored over 150 user manuals and API documentation guides for a variety of audiences.
- Expanded market reach by translating over 25 documents into Spanish.
- Increased content production speed by 40% by creating and implementing reusable templates.
- Designed and implemented the information architecture for this portfolio, creating a clear and intuitive structure that makes it easy for users to find and understand the content.
- 📧 e-mail: vega.pedro96@gmail.com
- LinkedIn: linkedin.com/in/pvega62
I'm working on a complete documentation sample teaching developers how to read data from the Sui blockchain using the TypeScript SDK. This set includes a conceptual guide, a step-by-step tutorial, and a focused API reference page, all centered on using the SuiClient to query object data.