Showing posts with label Technical Writing. Show all posts
Showing posts with label Technical Writing. Show all posts

Thursday, September 11, 2025

FROM CHAOS TO CLARITY: PFFMI

 


A DAY IN THE LIFE OF AN ITSM TECHNICAL WRITER

Introduction

Down the street and around the corner stands a building not unlike any other building, except in this building you'll find a familiar scene of phones ringing and help desk personnel answering calls. It’s a typical day, that is, until today. A year's worth of accomplishments needs to be compiled and presented to leadership by noon, transforming what would normally be a dreaded task into a focused effort within the TechWriter Zone.

The Grind of the Old Way

Situation

It's 8:30 AM. Maya, a seasoned technical writer in an ITSM organization, sips her coffee and opens her inbox. The annual accomplishments report is due in two weeks, and she’s been tasked with compiling it from dozens of trip reports, technical support summaries, and scattered project updates.

Challenge

The reports are inconsistent. Some are vague (“Improved ticket handling”), others are overly technical, and most lack measurable outcomes. Maya spends hours chasing down team leads for clarification:

·        “What was the actual impact of that workflow redesign?”

·        “Do we have metrics for the KB update?”

·        “Which services were affected by that outage?”

Frustration builds

She’s manually piecing together accomplishments, trying to reverse-engineer value from raw activity logs. The CMDB is underused, and dependencies between tasks and outcomes are unclear. She knows the teams did great work—but the story is buried in noise.

Enter CI-Driven PFFMI

Situation

Fast forward to 1:00 PM. Maya attends a training session on the new CI-Driven Problem Framing for Measurable Impact (PFFMI) framework. The organization has adopted a new approach: every problem is framed using measurable impact, and all resources—including KBs, workflows, and roles—are modeled as Configuration Items (CIs).

Transformation begins

·        Reports now follow a standardized template: Situation, Action, Result (SAR) format, linked CIs, predefined KPIs.

·        Each CI is mapped in the CMDB, showing dependencies and downstream effects.

·        Problems are no longer isolated—they’re systemic, traceable, and rich with context.

Maya opens a new report

Problem: SLA breach in incident resolution.

CI Impacted: KB-Article-LoginIssues, Tier2-Escalation-Flow, AppMonitor-v3.

Tasks: KB update, escalation redesign, alert tuning.

Outcome: MTTR reduced by 40%, SLA compliance improved to 95%, CSAT up 18%.

She smiles. The accomplishment statement practically writes itself.

Clarity, Confidence, and Strategic Value

Situation

It’s 5:00 PM. Maya wraps up her draft of the annual accomplishments report. This time, it’s not a patchwork—it’s a cohesive, data-driven narrative of how the organization delivered value.

Results:

·        Every accomplishment is tied to a CI and a measurable outcome.

·        The report highlights cross-functional collaboration and systemic improvements.

·        Leadership is thrilled: the report reads like a strategic roadmap, not a checklist.

Maya reflects

What used to take weeks now takes days. She’s not just documenting activity—she’s telling the story of transformation, impact, and excellence.

Takeaway

The shift to CI-Driven PFFMI didn’t just streamline reporting—it empowered Maya to elevate her role from documenter to storyteller, from compiler to strategist. And it gave the organization a clear, credible way to showcase its accomplishments.

About the Author

Daryl Horton is a technical and creative writer who is passionate about being creative. He has comprehensive training in business information management, information systems management, and creative and technical writing. Daryl has the knowledge and skills to help organizations optimize their performance and maximize their potential. He spent several years in a Knowledge Management PhD program at Walden University, nearly completing it, but resigned from the program during his dissertation phase to pursue his passion for creativity (http://www.abolitic.com/). Despite his love for creativity, he often finds himself participating in groups where his technical experiences add value.

You can find more information about Daryl Horton on his LinkedIn page at https://www.linkedin.com/in/darylhorton/.


Tuesday, August 5, 2025

Unified Document Approach


 

Streamlining Our Documentation: A Unified Approach for IT Operations

Introduction

In today's fast-paced IT environment, information overload is a constant challenge. Teams are juggling multiple document types, struggling with version control, and ultimately losing valuable time searching for the right resources. But what if there was a better way? Let’s explore how a unified approach to documentation can transform your operations – boosting efficiency and empowering your team.

The Problem – A Crisis in Documentation

“It was chaos,” Mark, our Senior Network Operations Center Analyst, confessed with a sigh. “Documentation practices were inefficient and fragmented, leading to low engagement and poor maintenance. The abundance of document types—such as operational guides, system guides, user guides, job aids, and run books—created confusion and discouraged employees from documenting their work. We weren’t just struggling with volume; we were battling a fundamental disconnect in how information was created, stored, and used.”

The core issue stemmed from the way IT Service Desk personnel – whose roles demand rapid response – often bypassed comprehensive documentation in favor of short-form knowledge base (KB) articles. These articles, however, were stored in a separate system and frequently maintained without input from technical writers, resulting in outdated and inconsistent information. This created a vicious cycle: the need for quick answers led to fragmented KB entries that further complicated finding accurate solutions.

This fragmented approach caused several critical issues:

·        Employees are unsure which document type to use or what content is required. The sheer variety of options paralyzed users, leading to hesitancy and ultimately, a reliance on informal methods.

·        Long-form documents become obsolete due to lack of updates. With no central governance, valuable operational guides languished, unused and out of date.

·        KB articles proliferate without proper oversight. The KB repository exploded in size, becoming a chaotic source of disconnected information.

·        Many resort to storing information in personal tools like OneNote, further decentralizing knowledge. This created isolated pockets of data, undermining any attempt at consistency or control.

Essentially, we were drowning in documentation because the evolution of our documentation process was out of synch with how we operated.

The Turning Point – A Unified Solution

That’s where I stepped in – as a technical writer – with an idea: a unified document template. We recognized that the solution wasn't just about creating more templates; it was about fundamentally changing how we approached documentation.  We proposed building a central SharePoint Online hub, leveraging existing document type templates and introducing a master template that would house common formatting styles and auto-text blocks. The goal? To eliminate the confusion surrounding document types and create a single source of truth for all our documentation.

Crucially, this addressed the KB issue by providing a framework for creating concise, targeted articles that could then be linked to from the master template.  We utilized MS Word’s Building Blocks and Auto Text to dynamically populate document types – ensuring consistency while allowing for tailored variations where needed. This wasn't about imposing rigid structures; it was about creating a flexible foundation for efficient documentation.

Resolution

Within weeks, the entire organization began adopting the unified template. The confusion vanished. The IT Service Desk team reported a significant reduction in call resolution times – they could quickly find and apply the correct procedures. The NOC team streamlined their incident response processes, leading to faster problem identification and resolution. “It’s not just about efficiency,” Mark concluded. “It's about empowering our teams to do their best work.” We’ve since expanded the template library and continue to refine it based on user feedback – a testament to the power of a well-structured approach.

Guiding Principle

Content First, Structure Second—Clarity Always.

A unified document template is a tool for coherence, not confinement. It provides a consistent framework for labeling and organizing information, but it must never overshadow the primacy of the content itself. The template exists to serve the message—not to define it. In every document, the goal is to make meaning accessible, not to impose meaning through form.

Short Manifesto: The Unified Template Ethos

1.       Label with Purpose
Document type labels clarify intent and context. They are signposts—not definitions.

2.       Structure with Integrity
Templates shape the flow of information, guiding readers without dictating thought. They are scaffolds—not cages.

3.       Honor the Content
The essence of any document lies in its ideas. Content must remain sovereign—unbound by format, free from dependency.

4.       Unify, Don’t Uniform
A unified template promotes harmony across documents, but never at the cost of individuality. It is a shared language—not a single voice.

5.       Adapt and Evolve
Templates must grow with the needs of the content they support. Rigidity is the enemy of relevance.

About the Author

Daryl Horton is a technical and creative writer who is passionate about being creative. He has comprehensive training in business information management, information systems management, and creative and technical writing. Daryl has the knowledge and skills to help organizations optimize their performance and maximize their potential. He spent several years in a Knowledge Management PhD program at Walden University, nearly completing it, but resigned from the program during his dissertation phase to pursue his passion for creativity (http://www.abolitic.com/). Despite his love for creativity, he often finds himself participating in groups where his technical experiences add value.

You can find more information about Daryl Horton on his LinkedIn page at https://www.linkedin.com/in/darylhorton/.

Friday, August 16, 2024

The Silent Struggle: How Business Communication Breaks Down in Silos

 


Business Communication: What do I know, who needs to know, have i told them?

Introduction

Meet Sarah, a retired US Marine who now serves as a marketing manager at a mid-sized company. Like many professionals, Sarah wears multiple hats and is responsible for managing various projects simultaneously. However, as her team grows and becomes more dispersed, she finds herself struggling to keep everyone on the same page. Despite having access to collaborative tools and communication platforms, Sarah's team still experiences delays, miscommunications, and errors that cost them valuable time and resources.

As a Marine, Sarah was trained in the importance of timely sharing of information for successful mission execution. She recalls the simple yet effective mantra that her unit lived by: "What do I know, Who needs to know, and Have I told them?" In combat, this mantra was crucial for making informed decisions and executing plans effectively. Similarly, in the business world, seamless communication is vital for driving growth and making informed decisions.

But what if you could have your cake and eat it too? In today's technological landscape, Microsoft Power Automate offers a solution to this problem.

The Solution

Power Automate allows data owners to maintain separate stores of data in SharePoint while still sharing information with other users and decision-makers who need it. With workflows within Power Automate, teams can:

·        Easily reuse collected data across different applications and processes

·        Seamlessly share information with others through automated notifications and updates

·        Maintain control over their data while still enabling collaboration and transparency

The Hero

Technical writers play a crucial role in helping organizations improve business communication by creating user-friendly documentation, guides, and tutorials that facilitate the adoption of new tools and technologies. By working closely with subject matter experts and stakeholders, technical writers can help bridge the gap between technical and non-technical teams, ensuring that everyone is on the same page.

Crossing the Threshold

By embracing Power Automate and leveraging the expertise of technical writers, organizations can break down silos and improve business communication. This requires a willingness to adapt to new technologies and processes, as well as a commitment to collaboration and transparency.

Potential Roadblocks

However, this journey is not without its challenges. Organizations may face resistance from team members who are hesitant to adopt new tools or processes. They may also encounter technical issues or data integrity concerns that require careful navigation.

The Reward

But the rewards of improved business communication far outweigh the challenges. By breaking down silos and facilitating open collaboration, organizations can:

·        Improve decision-making and reduce errors

·        Enhance customer satisfaction and loyalty

·        Increase productivity and efficiency



The Call to Action

If you're struggling with business communication in your organization, it's time to take action. Reach out to technical writers who can help you create user-friendly documentation and guides that facilitate the adoption of new tools and technologies. By embracing Power Automate and leveraging the expertise of technical writers, you can break down silos and improve business communication, ultimately driving growth and success for your organization.

About the Author

Daryl Horton is a technical and creative writer who is passionate about being creative. He has comprehensive training in business information management, information systems management, and creative and technical writing. Daryl has the knowledge and skills to help organizations optimize their performance and maximize their potential. He spent several years in a Knowledge Management PhD program at Walden University, nearly completing it, but resigned from the program during his dissertation phase to pursue his passion for creativity. Despite his love for creativity, he often finds himself participating in groups where his technical experiences add value.

You can find more information about Daryl Horton on his LinkedIn page at https://www.linkedin.com/in/darylhorton/.

Abolitic

Abolitic is more than a word; it is a vision inspired by the Abolitionist movement for freedom and justice. Abolitic believes that creativity can be a powerful force for positive social change when it comes from a place of love and respect. Abolitic is where art meets activism. Visit us to find out more at www.abolitic.com.

#BusinessCommunication #MicrosoftPowerAutomate #TechnicalWriting #CollaborationTools #StreamliningCommunication #BusinessSuccess #EffectiveCommunication

Thursday, January 18, 2024

Unleashing the Hidden Potential of Technical Writers

 


Unleashing the Hidden Potential of Technical Writers: Revolutionizing Business Process Management

Introduction

In the fast-paced world of business process management, there exists a group of unsung heroes - technical writers. These individuals possess a unique skill set that extends far beyond simply crafting words on a page. Join us as we embark on a captivating journey, delving into the story of a passionate technical writer who discovers the immense power he holds in supporting business process management through the development of document templates.

Harnessing the Power of Document Templates

Meet Jake, a young and recently hired technical writer who possesses an unwavering determination to revolutionize the way his organization approaches document creation. Armed with his expertise in technical writing, Jake has a profound realization - document templates are not merely tools for standardization; they hold the key to supporting business processes and driving efficiency.

However, Jake's vision of implementing standardized document templates is met with resistance from employees who are content with their existing methods. Fearful of change, they perceive templates as unnecessary constraints. Unfazed by their skepticism, Jake embarks on a quest to prove that document templates can streamline processes, save time, and reduce errors.

Yet, Jake soon encounters a significant obstacle - many business processes within his organization are either undocumented or immature. Without a clear understanding of these processes, the development of document templates becomes an arduous task. Unwavering in his determination, Jake takes on the formidable challenge of documenting these processes, unraveling complexities, and aligning them with the organization's needs.

Beyond the creation of standardized documents, the development of document templates requires Jake to navigate the delicate balance between capturing essential information and aligning with management's vision. Through collaborative efforts with stakeholders, he ensures that the document templates not only support the organization's goals but also deliver the desired outcomes.

With unwavering determination and resilience, Jake spearheads the development of document templates that not only streamline document creation but also transform the very fabric of the organization's processes. Through his expertise, he empowers employees to embrace change, documents previously undocumented processes, and aligns management expectations. The result? An organization that operates with enhanced efficiency and effectiveness, where every document seamlessly supports business process management.

Unlocking the Hidden Potential of Technical Writers

In the realm of business process management, technical writers like Jake are the unsung heroes. Their role extends far beyond writing; they serve as catalysts for change, driving efficiency, and transforming organizations. Through their expertise in document template development, they streamline processes, overcome resistance to change, and align with management's expectations. It is high time we recognize and unleash the hidden potential of technical writers - empowering them to revolutionize documents, processes, and outcomes.

About the Author

Daryl Horton is a technical and creative writer who is passionate about being creative. He has comprehensive training in business information management, information systems management, and creative and technical writing. Daryl has the knowledge and skills to help organizations optimize their performance and maximize their potential. He spent several years in a Knowledge Management PhD program at Walden University, nearly completing it, but resigned from the program during his dissertation phase to pursue his passion for creativity. Despite his love for creativity, he often finds himself participating in groups where his technical experiences add value.

You can find more information about Daryl Horton on his LinkedIn page at https://www.linkedin.com/in/darylhorton/.

Abolitic

Abolitic is more than a word; it is a vision inspired by the Abolitionist movement for freedom and justice. Abolitic believes that creativity can be a powerful force for positive social change when it comes from a place of love and respect. Abolitic is where art meets activism. Visit us to find out more at www.abolitic.com.