Technical writing portfolio
This is a portfolio dedicated soley to the software-related samples of my Technical Writing portfolio. It provides a comprehensive look at software documentation samples, all authored and published entirely in Markdown using Docusaurus. Here you'll find examples of developer guides, API references, and insights into the workflows used to create them.
I can't share most of my work due to NDAs, but this portfolio includes original content that demonstrates my technical writing skills and processes.
Portfolio navigation
Guides
- Installing and Applying a Theme to Google Chrome
- Using Postman to Connect to the Stripe API
- Microsoft Word to GitHub Wiki Workflow with Writage
- Route Cloud Application Logs Into a Pipeline
- Tutorial: Fetching Object Data
- Tutorial: Sending a Transaction
API References
- Stripe API Documentation
- Pet Store API Documentation
- Ingest Events via Streaming API
- SuiClient: getObject
- SuiClient: multiGetObjects
- SuiClient: getOwnedObjects
Conceptual/Overview Docs
To view the raw markdown files for these docs, head to GitHub.
Documentation workflow
- Drafting with Markdown in VS Code
- Markdown linting with Vale
- Translation with DeepL
- Diagram creation with Mermaid
- Docs versioning with Git
- API validation with Postman and Swagger/OpenAPI
- Publishing with Docusaurus
Technical stack
- Docusaurus: For generating the static site and documentation.
- VS Code: Primary editor for all content.
- Postman: For API testing and generating API documentation examples.
- Vale: For linting and ensuring style guide adherence.
- Git/GitHub: For version control and hosting.
- Mermaid Chart: Converting Mermaid code into images.
- DeepL MCP: For translation of documentation into multiple languages.
This mirrors how professional teams maintain developer documentation portals such as Docusaurus or similar static-site generators.
Each piece demonstrates end-to-end doc creation: research ? drafting ? review ? publishing.