Skip to content

Commit c90b69b

Browse files
Rebrand: 'technical writing' -> 'docs engineering' across site
35 substitutions across 14 files via case-preserving regex: Writing portfolio -> Docs Engineering Portfolio Lead Technical Writer -> Lead Docs Engineer Technical Writer -> Docs Engineer technical writing -> docs engineering technical writer -> docs engineer tech writer -> docs engineer Covers home page job titles, meta description, /docs/intro overview, and every role-specific page under docs/ably, docs/couchbase, docs/cdw, and docs/atlas-copco. Site copy in CheatSheetSeries (OWASP upstream clone) intentionally left alone. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 5a33090 commit c90b69b

16 files changed

Lines changed: 31 additions & 31 deletions

docs/ably/sse-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ This connected directly to the developer journey mapping work I was doing simult
4242

4343
The revised SSE documentation became one of the most-referenced pages in Ably's developer resources. More importantly, it reduced support ticket volume for SSE-related issues and improved successful implementation rates for developers choosing this protocol.
4444

45-
The systematic approach to troubleshooting and the focus on production-ready code examples influenced how I approached other protocol documentation at Ably. The principles I developed here - layered complexity, practical examples, and systematic troubleshooting - became central to all my subsequent technical writing projects.
45+
The systematic approach to troubleshooting and the focus on production-ready code examples influenced how I approached other protocol documentation at Ably. The principles I developed here - layered complexity, practical examples, and systematic troubleshooting - became central to all my subsequent docs engineering projects.

docs/ably/webhooks-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Webhooks security documentation
66

7-
When I took on rewriting Ably's [webhook security documentation](https://ably.com/docs/general/webhooks), I faced a classic technical writing challenge: how do you make security concepts practical without compromising safety? Security documentation typically falls into two traps - either it's too simplistic to be useful, or so complex that developers skip the security altogether.
7+
When I took on rewriting Ably's [webhook security documentation](https://ably.com/docs/general/webhooks), I faced a classic docs engineering challenge: how do you make security concepts practical without compromising safety? Security documentation typically falls into two traps - either it's too simplistic to be useful, or so complex that developers skip the security altogether.
88

99
The existing documentation had become a collection of theoretical concepts with few practical examples. Developers were implementing webhooks without proper security, not because they didn't care about security, but because they couldn't figure out how to implement it correctly from the documentation.
1010

docs/atlas-copco/flow-drill-fastening.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Similar to how I restructured information architecture at Ably, I organized this
4040

4141
The tape feed documentation became a model for other Atlas Copco product lines. The modular structure made it easy to adapt for different markets and applications. More importantly, it reduced the learning curve for new installations and improved troubleshooting efficiency when production issues arose.
4242

43-
This project taught me that industrial documentation requires the same user-centered thinking as software documentation, but with much higher stakes. The principles I learned here - clarity, safety-first thinking, and global accessibility - influenced how I approached every subsequent technical writing project.
43+
This project taught me that industrial documentation requires the same user-centered thinking as software documentation, but with much higher stakes. The principles I learned here - clarity, safety-first thinking, and global accessibility - influenced how I approached every subsequent docs engineering project.

docs/atlas-copco/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 4
44

55
# My work at Atlas Copco
66

7-
I worked as a Technical Writer at Atlas Copco from 2018 to 2021, writing documentation for industrial manufacturing equipment. My job was translating complex joining and fastening technologies into guides that engineers and factory workers could actually use.
7+
I worked as a Docs Engineer at Atlas Copco from 2018 to 2021, writing documentation for industrial manufacturing equipment. My job was translating complex joining and fastening technologies into guides that engineers and factory workers could actually use.
88

99

1010
## About Atlas Copco
@@ -90,6 +90,6 @@ You can see the results of this work in Atlas Copco's current resources:
9090

9191
## What I learned
9292

93-
Working at Atlas Copco taught me that technical writing isn't just about explaining how things work - it's about enabling people to do their jobs safely and efficiently. When your documentation goes to factories around the world, you realize how important clear, practical writing really is.
93+
Working at Atlas Copco taught me that docs engineering isn't just about explaining how things work - it's about enabling people to do their jobs safely and efficiently. When your documentation goes to factories around the world, you realize how important clear, practical writing really is.
9494

95-
The manufacturing industry showed me documentation at its most critical - where unclear instructions don't just frustrate users, they can shut down production lines or hurt people. That experience shaped how I approach all technical writing now.
95+
The manufacturing industry showed me documentation at its most critical - where unclear instructions don't just frustrate users, they can shut down production lines or hurt people. That experience shaped how I approach all docs engineering now.

docs/atlas-copco/industrial-dispensing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 4
44

55
# Henrob blow feed riveting documentation
66

7-
The Henrob blow feed riveting system presented a unique technical writing challenge at Atlas Copco. This was energy-efficient technology - achieving just 7Wh per rivet while delivering setting forces up to 85,000 N. The engineering was impressive, but making it accessible to production teams required a completely different approach.
7+
The Henrob blow feed riveting system presented a unique docs engineering challenge at Atlas Copco. This was energy-efficient technology - achieving just 7Wh per rivet while delivering setting forces up to 85,000 N. The engineering was impressive, but making it accessible to production teams required a completely different approach.
88

99
## Understanding the technology first
1010

@@ -52,7 +52,7 @@ I created modular documentation that could be adapted for different markets whil
5252

5353
Blow feed riveting didn't exist in isolation - it was part of Atlas Copco's complete joining portfolio. I made sure the documentation clearly explained when blow feed was the right choice versus tape feed or other methods.
5454

55-
This systems thinking became central to how I approached technical writing throughout my career. Individual technologies are just components in larger solutions, and documentation needs to help users understand those connections.
55+
This systems thinking became central to how I approached docs engineering throughout my career. Individual technologies are just components in larger solutions, and documentation needs to help users understand those connections.
5656

5757
## Results and continuous improvement
5858

docs/atlas-copco/self-pierce-riveting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,4 @@ The comprehensive documentation served critical business functions:
142142
- **Consistent training.** Standardized learning materials for global training programs.
143143
- **Continuous improvement.** Documentation framework supporting ongoing process optimization.
144144

145-
This SPR documentation project demonstrated how technical writing can directly impact manufacturing quality, efficiency, and global standardization in advanced automotive joining technologies.
145+
This SPR documentation project demonstrated how docs engineering can directly impact manufacturing quality, efficiency, and global standardization in advanced automotive joining technologies.

docs/cdw/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The documentation challenge was helping customers understand not just what techn
1414

1515
## Writing for multiple decision makers
1616

17-
Unlike the technical writing I had done at Atlas Copco or would later do at Ably, CDW documentation needed to serve multiple audiences simultaneously. A single cloud migration project might involve IT directors, compliance officers, finance teams, and technical implementers - each with different concerns and information needs.
17+
Unlike the docs engineering I had done at Atlas Copco or would later do at Ably, CDW documentation needed to serve multiple audiences simultaneously. A single cloud migration project might involve IT directors, compliance officers, finance teams, and technical implementers - each with different concerns and information needs.
1818

1919
I developed a modular documentation approach that provided different levels of detail for different roles while maintaining consistency across the overall solution architecture. This experience later influenced how I approached developer journey mapping at Ably.
2020

@@ -40,7 +40,7 @@ I developed templates for solution architecture documentation that showed custom
4040

4141
## Supporting the sales process
4242

43-
Unlike pure technical writing, my CDW work required understanding how documentation fits into the sales process. Technical materials needed to support proposal development, customer education, and post-sale implementation planning.
43+
Unlike pure docs engineering, my CDW work required understanding how documentation fits into the sales process. Technical materials needed to support proposal development, customer education, and post-sale implementation planning.
4444

4545
I created reusable content libraries that sales teams could adapt for different customer situations without starting from scratch each time. This improved proposal quality and consistency while reducing preparation time for complex technical sales.
4646

@@ -60,10 +60,10 @@ This specialization taught me the importance of understanding vendor ecosystems
6060

6161
The documentation frameworks I developed had measurable impact on CDW's sales process. Standardized technical materials improved proposal quality, reduced preparation time, and increased win rates by helping customers understand complex solutions more clearly.
6262

63-
More importantly, the documentation improved implementation success rates by setting clear expectations and providing practical guidance that customers could follow during project execution. This showed me how good technical writing directly impacts business outcomes in enterprise environments.
63+
More importantly, the documentation improved implementation success rates by setting clear expectations and providing practical guidance that customers could follow during project execution. This showed me how good docs engineering directly impacts business outcomes in enterprise environments.
6464

6565
## Enterprise writing lessons
6666

67-
Working at CDW taught me that technical writing in enterprise sales is fundamentally about building confidence. When customers are investing millions in technology implementations, they need to believe that the vendor truly understands their operational realities and can deliver successful outcomes.
67+
Working at CDW taught me that docs engineering in enterprise sales is fundamentally about building confidence. When customers are investing millions in technology implementations, they need to believe that the vendor truly understands their operational realities and can deliver successful outcomes.
6868

69-
The documentation skills I developed at CDW - modular content architecture, audience-specific information design, and business outcome orientation - became central to how I approached all subsequent technical writing projects. These principles proved essential when I later worked on developer experience optimization at Ably.
69+
The documentation skills I developed at CDW - modular content architecture, audience-specific information design, and business outcome orientation - became central to how I approached all subsequent docs engineering projects. These principles proved essential when I later worked on developer experience optimization at Ably.

docs/couchbase/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 3
44

55
# My time at Couchbase
66

7-
I was Lead Technical Writer at Couchbase from 2022 to 2023, focused on their mobile database platform. The main challenge was making NoSQL databases approachable for mobile developers who were used to simpler storage solutions.
7+
I was Lead Docs Engineer at Couchbase from 2022 to 2023, focused on their mobile database platform. The main challenge was making NoSQL databases approachable for mobile developers who were used to simpler storage solutions.
88

99
## The problem I inherited
1010

docs/couchbase/repository-consolidation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 3
44

55
# Repository consolidation project
66

7-
When I joined Couchbase as Lead Technical Writer, I inherited a documentation system that had grown organically over years of product development. What started as separate documentation efforts for different products had become a maintenance nightmare that made it nearly impossible for developers to understand how Couchbase's ecosystem worked together.
7+
When I joined Couchbase as Lead Docs Engineer, I inherited a documentation system that had grown organically over years of product development. What started as separate documentation efforts for different products had become a maintenance nightmare that made it nearly impossible for developers to understand how Couchbase's ecosystem worked together.
88

99
The [repository consolidation project](https://github.com/couchbase/docs-server) became my largest undertaking - not just moving files from one place to another, but redesigning how technical content could scale with a multi-product platform. This project taught me that information architecture isn't just about organizing content - it's about enabling developers to understand complex systems.
1010

docs/intro.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
sidebar_position: 1
33
---
44

5-
# Writing portfolio
5+
# Docs Engineering Portfolio
66

7-
When I started my career in technical writing, I thought documentation was just about explaining how things work. After years of working with developers at companies like Ably, Couchbase, and Atlas Copco, I've learned that great documentation is really about enabling people to succeed with complex technology.
7+
When I started my career in docs engineering, I thought documentation was just about explaining how things work. After years of working with developers at companies like Ably, Couchbase, and Atlas Copco, I've learned that great documentation is really about enabling people to succeed with complex technology.
88

99
My focus has been on taking complicated systems - from real-time messaging platforms to industrial manufacturing equipment - and creating documentation that developers and engineers can actually use to solve real problems. Each project taught me something different about how people learn and implement technology.
1010

@@ -80,7 +80,7 @@ Led comprehensive information architecture overhaul to improve developer experie
8080

8181
## My time at Couchbase
8282

83-
As Lead Technical Writer at Couchbase from 2022 to 2023, I worked on making NoSQL databases approachable for mobile developers. The challenge was explaining distributed database concepts to developers accustomed to simpler storage solutions, while maintaining the technical depth needed for production implementations.
83+
As Lead Docs Engineer at Couchbase from 2022 to 2023, I worked on making NoSQL databases approachable for mobile developers. The challenge was explaining distributed database concepts to developers accustomed to simpler storage solutions, while maintaining the technical depth needed for production implementations.
8484

8585
<div className="work-item">
8686

@@ -120,7 +120,7 @@ Consolidated fragmented documentation repositories into unified GitHub monorepo
120120

121121
## My work at Atlas Copco
122122

123-
Working as a Technical Writer at Atlas Copco from 2018 to 2021 taught me that manufacturing documentation can be life-or-death. When your documentation goes to factories worldwide, unclear instructions don't just frustrate users - they can shut down production lines or cause injuries.
123+
Working as a Docs Engineer at Atlas Copco from 2018 to 2021 taught me that manufacturing documentation can be life-or-death. When your documentation goes to factories worldwide, unclear instructions don't just frustrate users - they can shut down production lines or cause injuries.
124124

125125
<div className="work-item">
126126

@@ -165,7 +165,7 @@ Developed technical manuals for Henrob blow feed self-pierce riveting systems, f
165165

166166
## My work at CDW
167167

168-
My time as a Technical Solutions Specialist at CDW UK from 2021 to 2022 showed me how technical writing works in enterprise sales. Unlike developer-focused documentation, enterprise customers needed materials that helped multiple stakeholders - from IT directors to compliance officers - understand complex technology implementations.
168+
My time as a Technical Solutions Specialist at CDW UK from 2021 to 2022 showed me how docs engineering works in enterprise sales. Unlike developer-focused documentation, enterprise customers needed materials that helped multiple stakeholders - from IT directors to compliance officers - understand complex technology implementations.
169169

170170
<div className="work-item">
171171

@@ -215,6 +215,6 @@ Good documentation enhances learning through low effort and helps people problem
215215
| **Tested** | If the code doesn't work, the documentation is useless |
216216
| **Visual when needed** | Strategic use of images and diagrams to clarify complex concepts |
217217
| **Workflow-oriented** | Create maintainable documentation workflows that scale with teams |
218-
| **AI-assisted** | Implement AI systems for grunt work, freeing technical writers and UX teams to focus on user experience optimization |
218+
| **AI-assisted** | Implement AI systems for grunt work, freeing docs engineers and UX teams to focus on user experience optimization |
219219

220220
</div>

0 commit comments

Comments
 (0)