Technical writing
Technical writers are a Venn diagram of detective, translator, and librarian.
- Detective: Tracking down information across wikis, SharePoint, Confluence, legacy systems, and Subject Matter Experts (SMEs).
- Librarian: Knowing what information is available, what information users actually need, and where to find it.
- Translator: Tech writers interact with a bunch of folks with differing commands of the English language, as well as those whose priority or focus isn’t on the writing. We get it, we’re all busy. That’s where tech writers and editors come in.
Transforming technical communication for modern organizations
30+ years of experience means I’ve touched on all aspects of technical communication. My approach helps organizations not just create documentation, but build sustainable content ecosystems that drive user engagement and support business growth.
Strategic content leadership
-
Transform complex technical information into clear, user-focused documentation.
-
Implement data-driven content strategies that align with business objectives.
-
Build and maintain robust content governance frameworks.
-
Design scalable information architectures that grow with your organization.
-
Society for Technical Communication (STC) Associate Fellow.
-
Award-winning newsletter editor for STC NY Metro Chapter.
I’ve created:
- API reference documentation
- Cheat sheets
- eLearning modules
- Multimedia
- Online help
- PDF documentation
- Podcasts
- Printed manuals
- Technical illustrations
Docs as code
I use developer-focused tools like Jira, Markdown, Git, and VS Code to democratize content creation across your organization.
If you’re writing developer-focused (or -generated) content, there’s a good chance you’re working in a docs-as-code environment. Docs-as-code typically uses these tools to auto-generate documentation:
- Some sort of version control, like GitLab, GitHub, or BitBucket.
- A text-based, unstructured language like Markdown, AsciiDoc, or reStructuredText. These languages are easy to learn, easy to write, and are extremely portable. The downsides are often a lack of structure and governance.
- Conversion to HTML and display in a browser. This can be roll-your-own, or incorporated into various services like a CMS, GitHub Pages, static site generators, or other processors.
Agile and Jira
Agile is a software development methodology that features working on small tasks and deploying frequently. I have extensive experience with Jira and Agile:
- Defined user story guidelines that were adopted division-wide within three months of onboarding.
- Wrote user stories and epics following Gherkin language principles.
- Worked with Kanban and story boards.
Related presentations
-
So, you want to be a technical writer?
webinar
Content Wrangler webcast, 2024
-
Pros and Cons of using Markdown for tech docs
panel discussion
Content Wrangler webcast, 2024
-
Adding value as a technical communicator
webinar
STC Instructional Design and Learning special interest group, 2020
-
Timeless TechComm Tips
presentation
STC New England Interchange conference keynote, 2020
-
Drive your docs with data
webinar (video)
STC Instructional Design and Learning special interest group, 2018
-
Creating Beautiful Online Content with Web Fonts
article
STC Intercom magazine, 2017
-
Social media for technical communicators
presentation
STC Philadelphia Metro chapter Conduit conference, 2016
Tools used
- Acrobat Pro by Adobe
- Captivate by Adobe
- Cascading Stylesheets (CSS) by Open-source
- Confluence by Atlassian
- Extensible Stylesheet Language Transformation (XSLT) by Open-source
- Flare by MadCap
- FrameMaker by Adobe
- GitHub/GitLab by GitHub/Microsoft
- HTML by Open-source
- InDesign by Adobe
- Jira by Atlassian
- Markdown by John Gruber/open-source
- Nunjucks templating engine by Nunjucks
- OpenAPI (Swagger) by OpenAPI
- oXygen XML Editor by oXygen
- Photoshop by Adobe
- RoboHelp by Adobe
- SnagIt screen capture by SnagIt
- VS Code by Microsoft
- XML by Open-source