Mike Jang's portfolio
I’m including links to writing samples that represent my latest and best work, in several categories. I’ve described my role in each linked document, along with the following details.
- Toolchain
- SME
- Author
Some of these links use the Wayback Machine for access to my work, before others contributed to it.
Documentation from Scratch: Getting Started Guide
I created the first product documentation for Cobalt.io, including a Getting Started Guide.
| Criteria | Description |
|---|---|
| Toolchain | Hugo / Docsy |
| SME | Multiple PMs/Developers |
| Author | Myself |
| Others | As a “one-person” TW team, I had no others |
I also set up the associated GitHub repository from scratch, while learning a new documentation toolchain.
Conceptual Guide: Getting Started With IDM
I created the following mostly conceptual guide, to introduce newer users to a ForgeRock product: Getting Started With IDM.
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | DocBook / Java |
| SME | Multiple developers |
| Author | Myself |
| Others | Reviewed by multiple writers and a dedicated editor |
I used a scenario suggested by my manager and the product engineering director. As this was an original guide, I asked all (9) other writers within our group to review the guide.
Procedure: Securing a System
Based on my knowledge of Linux, I created the following appendix to help users secure their installations: Installing on a Read-Only Volume.
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | DocBook / Java |
| SME | Myself * |
| Author | Myself |
| Others | Reviewed by one other writer and a dedicated editor |
- Given my Linux experience, the relevant engineering manager accepted me as an author and SME on this document. However, I also got reviews from a relevant developer and QA engineer.
Procedure: Configuring User Self-Service
I wrote the following chapter to help developers create their own on user self-service UIs with REST commands and JSON code samples: Configuring User Self-Service.
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | DocBook / Java |
| SME | UI Developers, Engineering Director, Program Manager |
| Author | Myself |
| Others | Reviewed by one other writer and a dedicated editor |
API Reference
I set up documentation for a “Postman” collection: ForgeRock Cloud APIs.
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | Postman Pro (Markdown) |
| SME | UI Developers, Program Managers |
| Author | Myself |
| Others | Reviewed by one other writer and a dedicated editor |
I demonstrated the use of this collection at the end of a sprint.
Blog post
I created this blog post, as it was the simplest way to document integration between three products: ForgeRock Identity Platform Version 6: Integrating IDM, AM, and DS.
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | WordPress |
| SME | Multiple Developers, Document Manager |
| Author | Myself |
| Others | Reviewed by the documentation manager and a dedicated editor |
I used the content of the blog post to demonstrate integration between these products at an offsite unconference with customers and partners.
Educational Content
I’ve written a number of technical books, mostly on Linux. I include a link to a book that’s designed to help readers pass the “hands-on” Red Hat Certified Engineer Exam.
While the content is copyrighted, it’s available from booksellers such as Amazon:
Additional Information:
| Criteria | Description |
|---|---|
| Toolchain | LibreOffice |
| SME | Myself, Technical Editors |
| Author | Myself |
| Others | Reviewed by a style and copy editor |
This is one of 20+ books that I’ve written. Several colleges have used my books in their courses.