Ask most technical writers for writing samples and they cringe. What do you share? More importantly, how do you offer writing samples which prove your ability to engineer online documentation solutions for financial and software companies? My approach is to share a mix of technical documentation samples I’ve crafted as well as full-blown API documentation UIs I’ve built at the code level.
Due to NDA restrictions, I won’t be sharing confidential samples. Instead, I’ll share details of projects which were designed to be public-facing.
Project: API UI rebuild and rewrite.
Target audience: Developers.
Assignment details: Rebuild API UI and rewrite content adhering to the TowerData style guide. I coded the three-column format using Ruby | Slate | Markdown to support the code examples.
Project: API documentation.
Target audience: Developers.
Assignment details: the Stripe projects were a mix of helping developers blend a simplified UI with API code examples. My specific role was to solve the problem bridging the gap between developers and end-users to cut through complex connectivity blockers.
Project: API UI build.
Target audience: Fintech developers. Because of an NDA, all content is been stricken from the WEX API link below.
Assignment details: Design an online API resource UI for a virtual credit card product. I coded the three-column format using Ruby | Slate | Markdown to support code examples.
Project: Spark Analytics whitepaper.
Target audience: Big data analysts.
Assignment details: Craft a blended white paper balancing technical jargon with definitive reasons data scientists should consider adopting Apache Spark.
Project: Craft engaging blog posts on technical writing topics.
Target audience: API tech writers and project managers.
Assignment details: Write in-depth blog posts related to technical writing, technology and advice streamlining the hiring of technical writers.
Project: iMac Essentials user guide.
Target audience: New iMac users.
Assignment details: My contribution to the Apple iMac Essentials project was assisting the writing team by producing a visually appealing user guide. The challenge was factoring Apple’s use of white space into the text content. Especially by integrating Apple icons throughout the sentence structures.
Project: Write blog posts for Adobe Vice Presidents.
Target audience: Adobe followers.
Assignment details: Adobe engaged me to write blog posts for their VPs. The assignments were to dovetail creative approaches with Adobe tool solutions. The constraints were taking creative liberties to represent the professional perspectives of the VPs.
Project: Satirical blog posts.
Target audience: Tech followers desperate for something entertaining to read.
Assignment details: The Incipio blog posts bridged the gap between technology-related topics and humor. Because of the freedom to select my topics, I chose to delve into relevant newsworthy stories crafting engaging blog posts.