Accurate, concise, and well-written technical documentation, online help, and product copy help users to perform their tasks — but who helps the writers with their jobs?
- Content operations.1
All too often, content processes are mired in inefficiency, with repetitive manual tasks and legacy processes that slow teams down. Content operations helps to streamline the content creation process, allowing lone writers, small teams, and larger organizations to do more with less.
Question your processes
Though the answers are unique to each scenario, many of the questions we face as writers are common. I help content teams to build on best practices that have proven themselves in companies around the world.
Content design systems
Along with design systems that ensure consistent experiences and the UI pattern libraries that save software developers time, UX writers and content designers can add value by defining standards for UI copy.
- Does your design system include guidance for product content?
- Is your style guide separate from your component library?
- How do you share guidelines with everyone who needs them?
- Do your authoring tools prompt writers with usage guidelines?
- How is the system published, maintained, and deployed?
- Can content guidelines live in devs’ and designers’ tools?
- Can writers maintain content standards themselves?
UX writing and UI copy
Though text in the user interface is crucial to the product experience, content processes are often separated from design and development.
Content operations principles remove these barriers and help writers, designers, and developers to work better together.
- How do you find all the text that appears in your product’s UI?
- Do writers need to track text in spreadsheets and copy docs?
- Are your app’s text strings separate, or still embedded in the code?
- How do you ensure that text is consistent across platforms?
- Are your developers the only ones who can change product copy?
- Do devs have to copy and paste UI text from issue comments?
- Are your designers the only ones who can edit text in prototypes?
- Are they copying text from chats, docs, and slides to designs?
- Do your UI designs contain multiple copies of the same text?
- Does adjusting terms require changes in multiple places?
- How do you ensure writers review all new UI text?
Technical documentation workflows can be streamlined with single sourcing strategies and robust mechanisms for content re-use.
By integrating modern authoring tools in automated publishing environments and implementing a docs-as-code approach, teams can improve collaboration and release products faster.
- Do you maintain docs for multiple product versions and customers?
- How do you profile and filter content by audience or product?
- Do deliverables require manual effort once content is complete?
- Can publication and deployment process be automated?
- How can you improve review and signoff processes?
I can help you find answers
As a writer in the software industry for many years, I care about the tools & technology we use to create, automate, and publish product content.
I’ve written documentation for companies large and small — as a lone writer, and in global teams. Over the past few years, I’ve been working as a UX Writer, helping design teams to define standards for product copy, automating localization processes, and writing UI text.
Along the way, I’ve worked with a range of organizations at various stages of the content process maturity model, and have developed a good understanding for common pain points, what works at each stage, and how to take teams to the next level.
If the challenges above sound familiar, get in touch and let’s talk about how I can help your team to work smarter and build a better product.