Developer Documentation

Microsoft Corporation

Role: Lead Programming Writer

At Microsoft, as Lead Programming Writer, I was integral in creating detailed API documentation with practical code samples for developers. My tenure with the Windows CE/XP Embedded team was marked by leading a team of four writers, directing content creation for OEMs and ISVs focused on Windows CE-based platforms and applications.

Authoring Tools: Our team established an authoring process of using Microsoft Word with the “Glue” macro for MSDN formatting, later transitioning to “DocStudio” for content management. We managed version control through command-line tool “SLM”, evolving to Source Depot and Visual Source Safe, and collaborated with a dedicated build team for publication. Our shared build team managed the build infrastructure, ensuring our content was published both within the Windows CE Platform Builder and on MSDN.

Authoring Process: As a Lead Programming Writer, I was responsible for the Communications and Networking section of the Windows CE developer content set. Spending 70% of my time on new content and 30% on updates, I collaborated closely with PMs, SDETs, and developers for content accuracy and feedback incorporation. We followed a meticulous editing process according to the Microsoft Manual of Style, and maintained synchronization with the product’s 18-month waterfall release cycle.

Writing Examples:

My contributions included a diverse range of technical writings:

How to Set Up an 802.1x Network and Connect to It with a CEPC (Windows CE 5.0). A comprehensive guide on setting up an 802.1x network and connecting with a CEPC (Windows CE 5.0), establishing me as the go-to subject matter expert.

How to Create a Multilingual Run-time Image Using MUI (Windows CE 5.0) . Multilingual runtime image creation instructions using MUI (Windows CE 5.0) as part of our How-to initiative.

Developing a Gateway (Windows CE 5.0). Development of a Gateway (Windows CE 5.0) documentation, aligning with the team-wide task force for pre-configured solutions.

Remote Configuration Framework Feature Documentation. For this content I worked very closely with the developer who developed this code. We both tested the code and gave a talk at a Developer Conference on how to use this framework.

MSN Ad Center API Training: I authored this content to train Beta customers on how to use the MSN adCenter API. I delivered the training to Beta customers in Paris and London using the attached documents.

Introduction to MSN adCenter and the MSN adCenter API

MSDN adCenter API Training

Personal Blog: During my tenure at Microsoft I maintained a personal blog on MSDN titled Constanze’s Mobile Musings. Most of my posts were related to Windows Mobile development, such as this one: Ready to Port your iPhone App to Windows Mobile?

Rackspace

Role: Senior Information Developer

Audience: I crafted content targeting cloud developers using the Rackspace API and created numerous knowledge base and support articles for various cloud features. When I worked at Rackspace, developer and KB content was published on different portals. Today, all docs are hosted on docs.rackspace.com.

Authoring Tools: Initially, my team used Oxygen for authoring developer content and WADLs, and Drupal for general cloud articles. Source control was managed via GitHub, with varying practices across teams. In 2015, I was part of the transition towards a unified content management system, converting content to RST format using Sphinx and Pandoc, leading to an integrated content infrastructure that automated publishing upon GitHub merges.

Authoring Process: My responsibility spanned authoring and updating content for assigned areas, collaborating with feature teams and following Agile methodologies as part of a SCRUM team. Projects were handled through GitHub, and post-migration, I authored in RST format using Atom. With a single editor for the team, scheduling and communication were key to the editorial process.

Projects I Worked On:

Auto Scale: Collaborating with the San Francisco feature team, I gained in-depth knowledge to document solutions involving Auto Scale, testing APIs, and generating code samples.
Cloud Metrics: Splitting my time between San Francisco and Austin, I produced fresh content and tested APIs personally.
Rackspace Intelligence: A new high-visibility product that I documented by engaging closely with the development team.
Cloud Monitoring: I focused on updating and migrating existing documentation to the new format.
OpenStack: Contributing to the docs-as-code program, specifically on a feature known as Cloud Keep.

Writing Examples

DXC Technology

Role: Senior Technical Publications Manager

My role at DXC (formerly CSC) was Senior Technical Publications Team Manager at CSC. My responsibilities extended beyond managing a writing team of 5; I oversaw the content infrastructure, orchestrated content releases, and ensured seamless integration into the main product (Agility Platform) through continuous integration and deployment (CI/CD). Additionally, I managed the content team for the Agility Platform and was the principal author for the AWS Managed Services team, focusing on establishing a Docs-as-Code infrastructure and modernizing the content framework.

Audience:

Professional Services Team: Assisted businesses in deploying Agility Platform, including the installation of service and cloud adapters.
Agility Platform Admin and Business Users: Managed platform configuration and workload across multiple clouds.
AWS Managed Services Admin and Business Users: Handled setup and management of AWS services and workloads.

The content crafted by my team was designed for internal audiences only, encompassing both Agility Platform and AWS Managed Services documentation.

Authoring Tools and Processes:

Authored all Agility Platform content using MadCap Flare, producing outputs in HTML for the online Help system and PDFs for customer distribution.
Managed multiple projects that reflected Agility Platform’s structure, including guides for various adapters.
Established a private GitHub repository for Agility Platform content, adopting an engineering-like branching strategy for content versioning and integrating the technical content into the CI/CD pipeline via Jenkins.
Our team followed Agile principles, with each writer being an active SCRUM team member, responsible for sprint tasks, and using GitHub for content versioning.
I led the strategy for overall content, enhancement of tools, and the integration of customer feedback, with a focus on continuous improvement informed by direct feedback channels and professional services insights.
Authored comprehensive adapter guides and led the content efforts for the AWS Managed Services team, transitioning content from Wiki to Word/PDF and later to Docs-as-Code using GitHub Pages.

Writing Examples:

Agility Platform Install and Upgrade Guides: Critical documentation for customers navigating the complex installation and upgrade processes of the Agility Platform.

Agility Platform Install Guide

Agility Platform Upgrade Guide

Agility Platform Docker Swarm Service Adapter Guide: Solely authored this guide, utilizing a custom configured Agility Platform environment to ensure accuracy and completeness.

Agility Platform Docker Swarm Service Adapter Guide

DXC Managed Services for AWS Delivery Guide: Centralized guide for the CloudOps team, consolidating multiple Wiki articles into a cohesive and customer-friendly document.

DXC Managed Services for AWS Delivery Guide

Procore

Role: Documentation Manager

As the Documentation Manager at Procore, I led a 7-person team responsible for developing and maintaining documentation across two primary sites:

Procore Support Center: Designed for Procore support agents aiding customers and Procore tool suite users seeking specific information.
Procore Developer Center: Aimed at developers creating custom applications using the Procore API, and integrators embedding Procore functionality within their applications.

In 2021, I spearheaded the transition of our documentation team from the Customer Success to the Product and Engineering organization, aligning our efforts more closely with product development. This move placed us within the Globalization organization, where we conducted workshops to ensure that our content and tools were equipped for global reach and accessibility.

Audience:

Procore Support Center: Tailored to support agents and end-users of Procore’s suite, providing solutions and answers to enhance their product experience.
Procore Developer Center: Geared toward developers and integrators using the Procore API for building custom apps or integration solutions.

Authoring Tools and Processes:

My team managed their documentation tasks within JIRA, utilizing tagging and labels for organization across product releases.
The Support Center content was crafted in NICE (formerly MindTouch), with custom UI elements developed to meet our specific needs beyond MindTouch capabilities.
Developer Center documentation was created in Markdown and managed in GitHub, with the REST API adhering to the Open API Specification. Engineers wrote initial YAML files for REST endpoints, which were then refined by our writers, supported by a Gatsby-based ecosystem for hosting and managing content.

In my capacity, I developed a content strategy that supported company OKRs, implemented efficient publication processes, and engaged in content editing and writing. Notably, I composed new content for the Correspondence Tool, innovating with my Documentation Engineer to create unique UI elements for MindTouch. My collaboration extended to refining YAML files for API consistency and enhancing Developer Guide tutorials for user accessibility.

Writing Examples:

Authored all content for the Correspondence Tool, such as the following:
- Getting Started with the Correspondence Tool
Collaborated on a developer tutorial:
- Procore Developer Tutorial on Correspondence Tool

BigCommerce

Role: Senior Developer Relations Manager

As the Senior Developer Relations Manager at BigCommerce, I have led two teams:

Developer Relations Team: A team of three direct reports, who focus on fostering strong relationships with BigCommerce partners, including agencies and merchants who utilize the BigCommerce API for extending platform functionality. This team is responsible for creating and monitoring the content on the BigCommerce Community Portal.
Developer Documentation Team: A group of five direct reports who are dedicated to crafting clear, concise, and user-centric documentation for the BigCommerce Developer Center.

I joined BigCommerce in June 2022, at a time when both teams had been without direct leadership for over six months. My first objective was to provide immediate managerial support, establishing efficient JIRA processes and formulating a robust content strategy and roadmap aligned with the company’s OKRs.

Collaboration with the UX Design team was pivotal in redesigning the Developer Center to embrace user-centered design principles. Initially, the team used Stoplight for conceptual content and API reference pages. However, a mandate in November 2022 required us to transition away from Stoplight to an Open-Source content system within 90 days.

I directed this migration from inception to completion, working closely with a documentation engineer to select Docusaurus and Nextra, leveraging their capabilities to foster a customized, user-friendly layout. The initial migration phase was accomplished in under six weeks, a testament to the team’s agility and commitment.

In the subsequent phase, we collaborated with the UX team to revamp major landing pages, incorporating developer feedback from UX-conducted interviews. My role has been to balance the site redesign with the creation of feature-critical content, maintaining adherence to the user-centered design principles established by the UX team. I have also contributed directly to content enhancement initiatives, ensuring compliance with the OAS standard for YML files, refining Readmes for our open-source content, and scrutinizing Getting Started guides to guarantee a smooth developer onboarding experience.

Key Achievements:

Navigated the Developer Relations and Documentation teams through a critical transitional period, instilling structured processes and strategic direction.
Spearheaded the migration from Stoplight to a new Open-Source content authoring and rendering framework within a challenging three-month timeframe.
Led the integration of user-centered design into our documentation practices, significantly improving the developer experience.
Collaborated with UX design to redesign key landing pages for the Big Commerce Developer Center, such as Welcome to BigCommerce, API Reference, and Storefront.