Skip to content

JunstinLee/developer-docs-portfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Developer Documentation Portfolio

Practical samples of API references, Docs-as-Code workflows, and technical writing for developers.

This repository serves as my professional technical writing portfolio. It showcases my ability to translate complex software architectures, API endpoints, and engineering workflows into structured, low-friction developer documentation.


🛠️ Skills & Tech Stack

  • Methodologies: Docs-as-Code, Diátaxis Framework, Information Architecture
  • Standards & Style Guides: Google Developer Style Guide, OpenAPI 3.x (YAML/JSON)
  • Tooling & Environments: Markdown, Git/GitHub, GitHub Actions (CI/CD), Static Site Generators (Docusaurus/MkDocs)
  • Languages & Frameworks: Python, YAML, Shell Scripting

📂 Portfolio Directory (Diátaxis Mapped)

Below is a structured map of my documentation samples, categorized by the Diátaxis framework to demonstrate versatility across different user personas.

Doc Type Sample Document (GitHub Link) Published Source (Medium) Target Audience & Competency
Tutorial (How-to) product-guides/techdistill-workflow.md Python in Plain English Advanced Developers. Explains end-to-end CI/CD pipeline automation and multi-API orchestration.
Quick Start product-guides/techdistill-quickstart.md TechDistill Guide First-time Users. Zero-friction onboarding, prerequisite verification, and initial setup directives.
Explanation blog-posts/ai-agents-vs-mcp.md Towards AI Architects & Decision Makers. Conceptual analysis and mental model construction for abstract technologies.
Explanation (Edu) blog-posts/why-ai-forgets.md Artificial Intelligence in Plain English Junior Developers & PMs. Visual/metaphorical translation of dense CS concepts (Tokens & Context Windows).
API Reference api-reference/openapi.yaml N/A (Portfolio Exclusive) Machine & Developer Integration. OpenAPI 3.0 specification with strict error schemas and parameter types.
Tech Journalism blog-posts/claudecode-leak.md Towards AI Industry Stakeholders. Post-mortem analysis and technical trend tracking in the 2026 AI ecosystem.

🔄 Style Adaptability: Blog vs. Enterprise Style

To demonstrate my ability to adhere to strict corporate standards, I have documented my process for adapting narrative tech blogs into structured, sterile enterprise documentation.

👉 View the Style Adaptation Sample: style-adaptation/google-style-diff.md

This sample showcases:

  • Active-voice refactoring and removal of colloquialisms.
  • Restructuring narrative paragraphs into scannable imperative lists.
  • Compliance with the Google Developer Style Guide.

📬 Contact & Collaborations

I am available for freelance contracts, documentation audits, and API documentation portal setups.


⚖️ License

  • Code & Specs (YAML, JSON, Python scripts in this repo): Licensed under the MIT License.
  • Prose & Articles (Markdown guides, documentation pages): Licensed under CC BY-NC-SA 4.0.

About

Developer documentation portfolio featuring Docs-as-Code workflows, OpenAPI 3.0 specs, style guide adaptations, and end-to-end integration tutorials.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors