Technical Writing
Conceptual Documentation Project
<Include the Hoverboard Technical writing thing here>
Cyanscythe & Goldenmage Blog
<Insert a screenshot of the Cyanscythe and Goldenmage blog for some visuals as well as a description of the site and link the blog.>
Anima Vitae Point (2024-Present)
Most of the wiki writing I do contain contents that are internal to my company, thus I cannot share them.
As such, here is a list of my technical writing/documentation related accomplishments:
-
Migrated documents from old wikis to new wiki and consolidated them
-
Authored new and meticulously updated existing wiki content, ensuring logical organization, consistent formatting, and adequate detail to facilitate efficient information retrieval and knowledge sharing.
-
Spearheaded the investigation and validation of AlmaLinux as a potential replacement OS, performing comprehensive testing and documenting the technical and operational distinctions compared to Ubuntu.
-
Restored critical Animbot service post-power outage, overcoming a unique RLM server time synchronization error that persisted despite conventional file system fixes. Partnered with support and maintained transparent communication with impacted teams to ensure rapid service restoration and business continuity, then documented the fix.
-
Engineered the company's foundational technical onboarding module by expanding a single IT slide into a comprehensive 22-page training guide (a 2100% expansion). This definitive resource establishes best practices for the Linux OS, internal applications, remote work protocols, and provides critical cybersecurity training, including an incident response plan for phishing threats informed by a real-world case study.
-
Developed comprehensive network topology documentation and diagrams by systematically auditing switch configurations and analyzing router outputs (show ip route, show ip arp) to map traffic flows, identify network paths, and document all connected devices, significantly enhancing network transparency.
-
Implemented custom RAID 0 & 1 configurations on HP Proliant servers to optimize data performance - ensuring operating system fault tolerance - and authored comprehensive documentation outlining the procedure.
-
Implemented a high-performance bcache storage array using dedicated NVMe caches for multiple backing HDDs; successfully diagnosed and resolved critical kernel lock errors to achieve a stable, high-throughput configuration, and meticulously documented the entire process to establish a standard operating procedure.
Proofpoint (2019-2024)
The Work I can't Show
Most of the wiki writing I do contain contents that are internal to my company, thus I cannot share them. The ones below are examples of work that I can show, as they contain no sensitive information.
However, I wish to list out just a few of my Technical Writing-esque accomplishments at work which include:
-
Writing a 100+ page wiki on how to Provision one of the most complex products (to provision) of which I am the Subject Matter Expert (SME) of (which I will refer to as "The Product I'm SME of")
-
Creating prototypes for and documenting procedures for a large integration for "The Product I'm SME of"
-
Planning and documenting an extensive bootcamp to train my team on "The Product I'm SME of" in 2020, then again in 2022 after the integration mentioned above
-
Documenting New Product Integration (NPI) work procedures
-
Maintaining dozens of wikis and updating them when a new product/process/procedure comes into play
Wiki on How to Write a Nice Wiki
While Technical Writing is not my day job, at times when it's slow at work, I would work on creating and updating our wiki procedures. This, along with my personal love of writing as well as my curiosity, lead me to explore ways to use and fashion the wiki in more creative ways.
I wrote the "Wiki on How to Write a Nice Wiki" at the request of some colleagues who wanted to know how I made my wikis so nice. In here are all the tips and tricks I use to write nice wikis using Confluence Wikis whilst simultaneously displaying my Technical Writing skills.
OOFile System Documentation
This is a recording of me going through the wiki I wrote, documenting the scope, scale, testing, and planning I did for OOFileSystem V2 as my day job is not a Programming Job but I had a unique opportunity to try to become a shared resource to the Engineering Team.
While I was still a beginner in terms of trying to become a Programmer and shared resource, my Senior Software Engineer colleague complimented my technical documentation skills.
