Delivering accurate, timely solutions to users and customers is essential in ITSM. One of the most powerful tools available for achieving this goal is the Knowledge Base. When integrated with an ITSM platform like ServiceNow, the Knowledge Base becomes a central resource that not only helps resolve issues faster but also empowers both end-users and … Continue reading Leveraging Knowledge Base in ITSM
Tag: documentation
How AI is Transforming Technical Writing Careers
The rise of AI in technical writing has sparked a big debate: Will AI take over documentation jobs, or will it simply change how we work? Some companies are already looking for cheaper writers who rely on AI tools, but does that mean experienced technical writers are on the way out? Let’s break it down. … Continue reading How AI is Transforming Technical Writing Careers
Assessing Your IT Environment for ITSM Success: A Strategic Approach
Organizations rely heavily on their IT services to drive efficiency, productivity, and growth in today's business landscape. As IT becomes a cornerstone of operations, ensuring its alignment with business objectives and user needs becomes paramount. This is where IT Service Management (ITSM) plays a crucial role. However, before adopting ITSM practices, organizations must assess their … Continue reading Assessing Your IT Environment for ITSM Success: A Strategic Approach
How to Write for Different Technical Writing Audiences
In technical writing, one size does not fit all. Whether you're drafting user manuals, API documentation, or troubleshooting guides, your writing must meet the unique needs of your audience. But how do you know what tone, depth, and content will resonate with each group? In this post, we’ll explore how to tailor your writing for … Continue reading How to Write for Different Technical Writing Audiences
Mastering Branching Strategies for Documentation in Docs as Code
Branching strategies are essential in Docs as Code for enabling smooth collaboration, parallel updates, and efficient content management. While developers have long used branching to separate features, fixes, and releases, documentation teams can benefit from similar techniques to improve version control, handle urgent updates, and align content with product releases. Below, we explore three advanced … Continue reading Mastering Branching Strategies for Documentation in Docs as Code
The Software Documentation Lifecycle from Start to Finish
Documentation is crucial to any software project, guiding users, developers, and stakeholders in understanding how to use, maintain, and improve the product. However, for documentation to stay helpful, it needs to evolve with the software itself. Enter the Software Documentation Lifecycle, a framework that helps ensure your documentation stays accurate, useful, and up-to-date at each … Continue reading The Software Documentation Lifecycle from Start to Finish
Choosing Between Bullet Points and Tables in Technical Documentation
When creating technical documentation, the format in which you present information can greatly influence how users engage with and understand the content. Bullet points and tables are two versatile options that provide structure and clarity. However, each has unique strengths and is suited to different types of information. Understanding when to use a bullet-point list … Continue reading Choosing Between Bullet Points and Tables in Technical Documentation
A Docs as Code Strategy for your Doc Team
Docs as Code has long been associated with developer-centric workflows, but the same principles can empower documentation teams. By integrating Docs as Code into internal processes, writers can collaborate on code samples, improve accuracy, and ensure consistency across documentation. This article outlines a strategy for enabling doc teams to maintain and share their code samples … Continue reading A Docs as Code Strategy for your Doc Team
Streamline your Technical Writing Processes at a Startup
Startups are dynamic environments where efficiency and agility are critical to success. In this fast-paced world, technical writers must adopt strategies that deliver high-quality documentation while keeping up with quick product development. Here are some strategies for streamlining technical writing processes to maintain both speed and quality, based on techniques I’ve successfully applied. Define Clear … Continue reading Streamline your Technical Writing Processes at a Startup
Key Traits of Effective Technical Writing Managers in Software Companies
In software companies, the role of a technical writing manager is essential for producing clear, concise, and user-friendly documentation that helps users understand complex software products. As technology evolves, the demands on technical writing teams increase, making it vital for managers to cultivate a supportive environment while ensuring the quality and accuracy of documentation. This … Continue reading Key Traits of Effective Technical Writing Managers in Software Companies
Double Yew! 