Category: Document management

Why Technical Authors are disappearing from IT Projects

Technical authors are vanishing from many IT projects.

Project managers, hire a technical author
Hiring a suitable Technical Author

Not because documentation is no longer needed.

But because organisations convinced themselves that:

      • Agile removed the need for documentation
      • SMEs could “just write it”
      • Developers could document as they build
      • Wikis replaced structured information management
      • AI can now generate everything automatically

The result?

Documentation did not disappear. Ownership disappeared.

The Agile Misinterpretation

IT misunderstood Agile, believing it meant:

Less documentation.

What Agile challenged was:

      • Excessive bureaucracy
      • Huge unused specification sets
      • Documentation written for sign-off instead of operational value

But somewhere along the line, many organisations translated this into:

We no longer need technical authors.

So documentation responsibilities were fragmented across:

      • Developers
      • Business analysts
      • Product owners
      • Service managers
      • Support teams

Everyone became partially responsible.

Which usually means nobody became fully accountable.

IT Projects Still Produce Complexity

Modern IT environments are not simpler but more complex than they were 20 years ago.

Today’s projects involve:

      • Cloud platforms
      • APIs
      • Identity management
      • Cybersecurity controls
      • SaaS integrations
      • DevOps pipelines
      • Automation
      • Data governance
      • Compliance obligations
      • Hybrid infrastructure
      • AI systems

Yet many projects still assume documentation can “emerge naturally.”

What usually emerges is:

      • Scattered Confluence pages
      • Outdated SharePoint libraries
      • Tribal knowledge
      • Slack conversations acting as operational memory
      • Contradictory procedures
      • Uncontrolled revisions

Eventually, operational support inherits the chaos.

The “SMEs Will Write It” Fantasy

Subject Matter Experts are essential.

But SMEs are not usually:

      • Information architects
      • Editors
      • Audience analysts
      • Metadata specialists
      • Structured writing professionals
      • Governance specialists

Most SMEs focus on:

      • Delivering systems
      • Solving technical problems
      • Meeting deadlines

Documentation becomes secondary.

Postponed until the last phase of a project — when schedules collapse, and budgets tighten.

That is where technical authors historically added value:

      • Extracting knowledge
      • Structuring information
      • Standardising terminology
      • Identifying gaps
      • Challenging ambiguity
      • Creating usable operational guidance

Without that role, knowledge quality declines rapidly.

Documentation became Invisible Work.

In many IT organisations, documentation is now treated as:

      • Administrative overhead
      • Non-billable effort
      • A project afterthought
      • Something AI can “tidy up later”

Yet the same organisations later struggle with:

      • Failed handovers
      • Poor onboarding
      • Repeated incidents
      • Knowledge loss
      • Service desk dependency
      • Operational inconsistency
      • Audit failures

Because undocumented systems create operational drag.

The irony is simple:
The more complex IT becomes, the more valuable structured information becomes.

AI is speeding up the illusion

AI has amplified the belief that technical writing is “generating text.”

But experienced technical authors are not typists.

They managed:

      • Information quality
      • Knowledge structures
      • Content governance
      • Audience interpretation
      • Process consistency
      • Lifecycle control
      • Information retrieval
      • Operational usability

While AI can produce drafts quickly, it does not inherently:

      • Understand organisational risk
      • Detect conflicting operational procedures
      • Validate technical accuracy
      • Govern document lifecycles
      • Manage controlled information environments

Many times, AI speeds up the production of unmanaged content.

The Hidden Shift

Interestingly, technical authors have not entirely disappeared. We have changed titles:

Across IT projects, former technical authors now operate as:

      • Information managers
      • Knowledge managers
      • Content strategists
      • Service transition analysts
      • Governance specialists
      • Digital adoption consultants
      • Documentation engineers
      • Information architects

The writing component became only one part of a broader information role.

The Long-Term Risk

IT projects can survive in the short term without dedicated technical authors.

Until:

      • Key staff leave
      • Systems fail
      • Audits occur
      • Services scale
      • Migrations happen
      • Security incidents arise
      • Regulatory scrutiny increases

Then organisations rediscover the same truth:

      • Operational resilience depends on reliable information.
      • And reliable information rarely happens accidentally.
      • The disappearance of technical authors from IT projects may save money on a spreadsheet.
      • But over time, many organisations discover that they have not removed the need for technical authors.
      • They merely removed the people responsible for keeping organisational knowledge usable.

The Hidden Cost of Cutting Your Technical Author

The Hidden Cost of Cutting Your Technical Author

When budgets shrink, technical authors and documentation teams are often the first to be cut. It’s easy to justify — “We already have the templates.”
But removing or not replacing your technical author rarely saves money. It hides the cost until it explodes.

1. Knowledge Loss

A technical writer understands how different parts of documentation fit together.
When they leave:

      • Knowledge silos collapse.
      • People work from outdated copies.
      • Time is wasted rediscovering old lessons.

The cost of confusion soon outweighs the saved salary when a technical author is missing.

2. Compliance and Audit Risk

Accurate documentation underpins certifications such as ISO 9001, ISO 27001, PCI DSS, GDPR, and ITIL.
When documents are out of date or mislabelled:

      • Audit evidence disappears.
      • Nonconformities multiply.
      • Certification renewals become a gamble.

Even one mismatched title or missing version record can result in audit failure. Without the oversight of a technical author, these issues are more likely to occur.

3. Operational Inefficiency

Without a technical author:

      • Everyone edits documents their own way.
      • Version control collapses.
      • People spend hours searching instead of producing.

It’s not efficiency — it’s chaos disguised as productivity. A skilled technical author maintains order.

4. Loss of Professional Polish

Documentation is a reflection of your organisation’s competence. When quality drops:

      • Clients notice inconsistent tone and structure.
      • Reports lose credibility.
      • Your brand looks disorganised.

A technical author provides the invisible glue that holds professional standards together.

5. Increased Risk and Cost

When no one owns the documentation:

      • Processes contradict each other.
      • Projects lose traceability.
      • Clients misinterpret requirements.

Eventually, you’ll hire a contractor to rebuild the documentation ecosystem — and pay three times what you “saved.” A technical author prevents these costly mistakes.

6. Demoralised Teams

Without a dedicated author:

      • Engineers are forced to write in their spare time.
      • Quality suffers because writing is not their priority.
      • Ownership disappears — and so does accountability.

Documentation becomes everyone’s side job and nobody’s responsibility. Here, a technical author provides much-needed oversight.

⚙️ In Summary

Short-Term Thinking Long-Term Reality
“We’ll save a salary.” You’ll pay three times more later to fix it.
“Anyone can write.” Not everyone can structure or govern documents.
“We have templates.” Templates without governance are worthless.
“We’ll update later.” “Later” becomes “never” — and non-compliance follows.

My Final Thought

Removing your technical author isn’t cost-saving. It’s cost-shifting.
You’re trading short-term budget relief for long-term operational debt. The moment a compliance audit or client review exposes the cracks, the real bill arrives

When Document Titles Don’t Match Their Content: A Hidden ISO 27001 Audit Risk

In my career I have worked on several contracts correcting documents that failed an ISO27001 audit. I found several change management process documents that were anything but processes. They were plans with a workflow diagram, but the main part of the text explained the planning, not the exact steps.

This mismatch between title and content can undermine an ISO 27001 audit. Users and auditors will struggle if document names don’t match the content, leading to wasted time and a lack of trust in the documentation.

Why It Matters?

ISO 27001 requires documentation to be consistent, accurate, and traceable. Under Clause 7.5, all documented information must be suitable and adequate for its purpose.
If your titles mislead the reader — for instance, labelling a plan as a process — it fails that requirement outright.

Auditors don’t just check boxes; they follow document trails. Incorrectly named or categorised documents suggest your information management and document control are weak. That can lead to a nonconformity finding and a costly re-audit.

The Domino Effect of Wrong Titles

Incorrectly titled documents have consequences beyond compliance:

      • Search confusion: Teams waste time locating or referencing the wrong document.
      • Duplicated effort: Multiple people recreate or update files that already exist, under a different name.
      • Loss of trust: Users stop relying on the repository, assuming it’s unreliable.
      • Audit remediation time: Technical authors must spend months re-titling, rewriting, and re-validating content.

Every mis-titled document represents avoidable technical debt that eventually needs to be paid back — usually as long, tedious remediation work.

The Cost of Inaccuracy

In one project, we discovered over 200 documents whose titles didn’t match their content. Entire categories had to be re-audited, cross-referenced, and reissued.
The team lost weeks, and the company risked missing its ISO 27001 renewal.

This wasn’t a writing issue — it was a metadata and document control failure. Titles, categories, and filenames are all metadata fields that auditors use to navigate your Information Security Management System (ISMS). When those don’t align, your ISMS fails to demonstrate control.

How to Get It Right

  1. Align title and intent
      • If it’s a process, describe repeatable steps.
      • If it’s a plan, define scope, actions, and timelines.
  1. Use controlled metadata
      • Add document owner, version, and approval date.
      • Classify documents by type and purpose.
  1. Include a clear scope statement
      • A single line beneath the title explaining purpose helps readers instantly understand what they’re reading.
  1. Review your taxonomy
      • Periodically audit your repository to ensure naming conventions still reflect actual content.
  1. Engage technical authors early
      • They can design taxonomies, enforce naming conventions, and prevent this issue before it becomes a compliance risk.

Final Thought

A wrong title might not seem serious — until an auditor can’t find what they’re looking for.
When document names and content don’t align, it’s more than a clerical error; it’s a failure of document control.

Accurate titling and classification aren’t just about neatness — they’re a sign that your organisation takes information management, and ISO 27001 compliance, seriously.

If your document library has grown organically over the years, now’s the time to review it.
A few days of focused taxonomy work today can save months of painful remediation tomorrow.

Author Bio:
Michael Clark is a Senior Technical Author and Information Management Specialist at AtkinsRealis, with extensive experience in documentation strategy, metadata design, and ISO 27001 compliance. He writes about documentation standards, information governance, and practical approaches to managing technical content across large organisations.

The Hidden Cost of Ignoring Your Technical Author

Why documentation fails when managers don’t listen

The real problem isn’t the writing — It’s not listening to experience.

Management’s lack of focus, not a writer’s skill, causes projects to be poorly documented. A seasoned author can design a structure, build consistency, and maintain control over hundreds of evolving documents.

Yet, repeatedly, managers bypass their input:

      • They hand over blank Word files and call them “templates.”
      • They expect one-off deliverables rather than an ongoing lifecycle.
      • They set unrealistic deadlines that ignore review, approval, and publishing time.

When leadership dismisses this expertise, documentation quickly becomes a liability.

Ignored expertise, predictable problems

When you ignore a technical author’s recommendations, you’ll eventually see:

      • Version Confusion: No one knows which file is the current one.
      • Template Drift: Every department uses its own layout.
      • Audit Failures: Documents lack metadata or controlled approval trails.
      • Lost Knowledge: Critical information walks out the door with departing staff.
      • Rework Costs: Teams rewrite what already exists — again and again.

Documentation doesn’t happen by accident. It’s engineered through planning, governance, and review.

The Author’s Perspective: More Than a Writer

The best authors think like strategists.
They understand:

      • ISO 9001/27001 compliance needs
      • Metadata and taxonomy for search and retrieval
      • Information architecture for user navigation
      • System integrations with DMS platforms like Asite or SharePoint

In short, they build the bridge between information and understanding.
Ignoring that expertise is like ignoring the architect when building your house — you might save a few days, but you’ll pay for it later.

The Cost of Not Listening

The fallout can be subtle or severe:

      • Staff waste hours searching for outdated documents.
      • Projects fail audits for poor control and traceability.
      • Clients lose confidence in your quality assurance.

Listening early avoids all of this.
A short meeting with your technical author at the planning stage can save weeks of remediation later.

A Simple Shift in Thinking

The next time you start a project, ask:

“What’s our documentation strategy?”
“Who owns the lifecycle?”
“How will we manage updates after go-live?”

If those questions draw blank faces, it’s time to let your technical author lead the way.

Because documentation isn’t an afterthought — it’s part of your operational DNA.
Ignore it, and you’ll eventually pay the price.

Using Your Technical Authors as Strategists, Planners, and Consultants

Many businesses still misunderstand what a technical author can deliver.
They see a writer — not a strategist. A formatter, not a planner. A proofreader — not a consultant.

When used correctly, technical authors bring structure, compliance, and clarity to every stage of the information lifecycle. They turn documentation into a strategic enabler that supports ISO certification, ITSM frameworks, and information governance.

I didn’t gain this experience by taking on low-level contracts.
I built it by accepting complex, high-expectation assignments that demanded expertise — not routine.
Projects governed by ISO 27001, ISO 9001, PCI DSS, GDPR, and ITIL-aligned IT Service Management (ITSM) systems, where documentation wasn’t an afterthought, but a control in its own right.

From Document Writer to Information Strategist

Early in my career, I learned that a procedure is only as good as the system it supports.
As I advanced, I began designing those systems — integrating documentation with SharePoint, Asite, and enterprise knowledge bases to create traceable, auditable, and user-friendly environments.

That shift — from producing documents to architecting knowledge — is what separates an average writer from a documentation strategist.

Embedding ISO and Regulatory Frameworks

ISO 9001 — Quality Management

ISO 9001 demands consistency, clarity, and control. Technical authors design document templates, review workflows, and approval paths that prove process reliability. Well-structured documentation becomes part of the organisation’s quality evidence during internal and external audits.

ISO 27001 — Information Security

Under ISO 27001, documentation itself is a security control. Policies, risk registers, and incident procedures must align with the ISMS.
Experienced authors ensure classification, access permissions, and audit records are built into the documentation framework, not bolted on afterwards.

PCI DSS — Payment Card Security

PCI DSS requires clear operational documentation to evidence data protection. Authors provide traceable, reviewed, and controlled documents that survive audit scrutiny and demonstrate compliance with strict data-handling protocols.

GDPR — Data Protection and Privacy

GDPR compliance relies on transparency and accountability. Technical authors transform complex regulation into usable, plain-English policies: data-retention schedules, subject-access request processes, and breach-notification guides that staff can actually understand and apply.

Aligning Documentation with ITIL and ITSM

In IT environments, documentation underpins every ITIL and IT Service Management process:

      • Incident Management: Documenting escalation paths and resolution steps for service continuity.
      • Change Management: Recording change requests, approvals, and rollback plans to ensure traceability.
      • Problem Management: Capturing known errors and lessons learned to improve service quality.
      • Configuration & Asset Management: Maintaining controlled, versioned records of infrastructure and applications.
      • Service Continuity: Creating and maintaining recovery and resilience documentation aligned with ISO 22301.

A technical author versed in ITIL ensures that every process has the appropriate governance and documentation frameworks to meet compliance, audit, and service-delivery standards.

Aligning with Information Management and Document Control

Technical authors sit at the crossroads of Information Management (IM) and Document Control (DC) — translating policies into practice and ensuring that every piece of information has purpose, ownership, and lifecycle control.

      • In Information Management, authors define how data becomes information — creating naming conventions, metadata structures, taxonomies, and templates that keep repositories usable and compliant.
      • In Document Control, they understand versioning, approval hierarchies, baselining, and retention schedules — the mechanisms that give documentation its legal and operational validity.
      • Together, these functions ensure that knowledge doesn’t just exist, but is managed, retrievable, and auditable across departments, projects, and systems.

Where Information Management provides governance and Document Control enforces consistency, technical authors provide the structure and clarity that make both work.

The Modern Technical Author’s Toolkit

Today’s senior technical author is:

      • A strategist, aligning documentation with ISO, GDPR, ITIL, and corporate frameworks.
      • A planner, integrating documentation into project and service lifecycles.
      • A consultant, advising leadership on governance, information management, and document control.
      • A knowledge manager, ensuring content remains accurate, traceable, and secure.
      • A systems designer, configuring SharePoint or Asite to automate metadata, version control, and review cycles.

When you position your technical authors at this level, you gain more than documentation — you gain information assurance.

Experience Earned Through Expertise

Every project I’ve worked on — from ISO 9001 audits to 27001 ISMS documentation, from GDPR compliance to ITIL process alignment — has reinforced one truth:
Documentation is infrastructure.

It connects people, process, and technology.
It demonstrates governance and compliance.
And when managed properly, it becomes the backbone of every successful audit and transformation.

Final Thought

Technical authors who have grown through challenging environments understand how documentation supports the wider information ecosystem — policy, process, system, and control.

They close the gaps between communication and compliance, between information and evidence.

So before assigning your technical authors to “tidy up templates,” ask instead:

“Can this person help us align ISO, ITIL, and Information Management requirements into a single, coherent documentation strategy?”

If the answer is yes, you’re not hiring a writer.
You’re engaging a strategic partner in governance, compliance, and service excellence.

Why do managers struggle to understand their Technical Authors?

A common challenge for tech writers like me is that their managers often do not fully understand our roles. When managers underestimate our abilities, things are easier for them, but challenging for us.

Based on my experience, managers often overlook

    • the critical contribution of documentation to risk reduction, compliance, and operational efficiency.
    • Producing documentation requires significant effort.
    • The cross-functional nature of our work can create confusion about team assignments. Say we have change management experience in the creation of flows and narratives. It led to a placement in business change where we possess the knowledge but not the expertise.
  • Difficulty in Justifying ROI to Clients
      • Clients see documentation as a “nice-to-have” rather than a must-have—until something goes wrong (e.g., legal disputes, compliance failures).

Managers struggle to understand how documentation:

      • Reduces support costs (fewer customer complaints)
      • Ensures compliance (avoids regulatory penalties)
      • Speeds up onboarding (reduces training costs

The misconception that AI or SMEs can replace us by writing documentation, or that AI tools can auto-generate content. Small businesses often don’t have technical writing skills, and AI content needs a person to check it for correctness, meaning, and how easy it is to use.

How can we address these challenges?

  1. Educate Managers on the Value of Documentation
        • Show real-world cost savings (e.g., reduced rework, fewer customer complaints).
        • Highlight case studies where poor documentation caused project delays or legal risks.
    2. Push for Strategic Placement in the Organisation
      • Place this under Quality, Knowledge Management, or Digital Strategy (if it helps the business).
      • Position documentation as a core business function, not as an afterthought.

3. Demonstrate Our Expertise Beyond Writing

      • Emphasise our role in governance, process improvement, content structuring, and compliance.
      • Showcase technical authors as information architects rather than just writers.

Interested in a proposal to improve how your organisation uses technical authors? Ask me?

Technical Author: How Simple or Easy Is our job?

Let’s start with a question: what skills are essential for excelling in a technical author job?

      1. How many of you have technical authors on your team but do not know what they do?
      2. Have you tried to fit them in somewhere, or wanted to find them a role and failed?
      3. Have you written technical documentation for a client? If so, how did it go?

You may have given up trying to understand their role, thinking you should upskill them to meet your priorities. You might not grasp what technical authors contribute in their jobs and underestimate their potential.

Let’s examine the issue.

Managers often perceive technical authoring as “writing documents.” However, in reality, it is a complex, multidisciplinary role that requires expertise in several areas. One important area is understanding the technical author’s job in depth:

Understanding Technical Information

Technical authors translate complex concepts into clear, user-friendly documentation that is easy to understand. They engage with Subject Matter Experts (SMEs), interpret complex jargon, and ensure the accuracy of the information presented.

Structuring and Standardising Content

They do more than write. Technical writers need to work with formatting, templates, metadata, and indexing, which makes their job complex.

Managing Multiple Stakeholders and Reviews  

Technical authors liaise with stakeholders and end users, each with different priorities and expectations.

The process involves multiple reviews by experts, who underestimate the work required to improve the documents. This aspect is a key part of their jobs.

Adapting to Evolving Tools and Technologies  

From document management systems (DMS) like SharePoint, Confluence, and Asite to API documentation tools, technical authors must stay up-to-date with the constantly evolving industry standards. AI and automation are changing the nature of jobs and making technical writing more complex.

Balancing Quality with Deadlines  

Managers don’t always prioritise documentation, which means writers have to finish it quickly, but still produce great work.

They must work within strict project deadlines while ensuring accuracy, compliance, and usability. These demands highlight the challenges inherent in a technical author’s job.

Why do managers struggle with technical authors and their role? Let me know in the comments.

How to Win Over Management and SMEs: A Hilarious Guide for Technical Authors

So, you’ve embarked on the noble quest of a technical author. Your mission, should you accept it (and you have no choice), is to convert the mighty management and the enigmatic SMEs (Subject Matter Experts) to your way of thinking. Sounds like a Herculean task? Fear not! Here’s your humorous guide to charming them into submission while keeping your sanity intact. Remember, we’re all in this together, united by the common goal of effective communication. So how to Win Over Management and SMEs to your way of thinking.

Speak Their Language (No, Not Klingon)

Let’s be honest—management speaks in KPIs and ROI, while SMEs converse in an ancient dialect known only to a few. Your first step is to become a polyglot. Learn to weave your documentation magic into business objectives and arcane technical details. It’s like being a translator at the United Nations but with less chance of starting an international incident.

The Art of Presentation: Smoke and Mirrors

With communication, clarity icriticaley. But why stop there? Make your points with the flair of a Las Vegas magician. Use charts, graphs, and infographics that sparkle. And remember, nothing says “I know what I’m talking about” like a well-timed meme. Trust me; pie charts are irresistible to management as cat videos are to the internet. Please don’t overdo it, or you will end up in a meme yourself!

Quick Wins: The Fast and the Furious

Management loves results faster than a pizza delivery. And who’s the hero delivering those results? You, the technical author. Identify accessible opportunities and deliver those quick wins like Vin Diesel in a muscle car. A tiny tweak will save an hour of work each week or a new tool that doesn’t require a PhD. Shout about those victories with the enthusiasm of a game show host handing out prizes. You’re the star of this show.

Collaboration: Herding Cats, but With Treats

Getting management and SMEs to work together is like herding cats, but don’t worry—we have treats! Engage them early with workshops that are part of brainstorming and therapy sessions. Provide plenty of coffee and snacks; they’re more likely to engage if their blood sugar levels are stable. Plus, who argues over a cookie?

Build Relationships: Be the Office Barista

Relationships are everything. Become the office barista—always ready with a listening ear and coffee. Trust and rapport are your best friends. Remember, it’s harder to say no to someone who knows your coffee order by heart.

Highlight Long-term Benefits: The Crystal Ball Approach

Paint a picture of a future so bright they’ll need shades. Highlight how your approach will lead to fewer headaches, lower costs, and maybe even a tropical vacation (we can dream). Show them the long-term benefits with the enthusiasm of a late-night infomercial host. “But wait, there’s more! If you adopt this strategy now, you’ll also get…”

Embrace Technology: The Cool Kid in School

Introduce new tools and technologies like you’re showing off the latest gadget. Be the cool kid who knows all the shortcuts and secret features. Offer training sessions, but make them fun—think less “seminar” and more “techno party.” Bonus points if you can throw in a few tech-related jokes. “Why do programmers prefer dark mode? Because light attracts bugs!”

Example Scenarios:

      • Scenario 1: Management Concerned About Cost: “Dear Management, investing in this new tool is like buying a golden goose. It’s pricey upfront, but think of the endless eggs. In financial terms, that means reduced time, fewer errors, and overall productivity that will make our competitors weep.”
      • Scenario 2: SME Resistance to Change: “Dear SMEs, we know you love your ancient rituals, but imagine a world where documentation is a breeze. Join our workshop—there will be snacks!—and let’s create a workflow so smooth, you’ll forget what life was like before.”

Ultimately, winning over management and SMEs is about strategy, charm, and humour. So, arm yourself with these tips and spread the word about the importance of good documentation. Keep in mind that these strategies have been tried and tested. If all else fails, remember that bribery with baked goods is always an option. With these tools, success is inevitable.

IT Audits: a Technical Authoring view

IT Audits: A technical author’s view from the front line. I have worked on several projects, including an audit of a company’s IT ahead of a migration from one data centre to another. In three cases, no documentation existed; in the fourth, documentation was scattered around in various places.

Tweet
Pin
Share
0 Shares

IT Audits

IT Audits: A technical author’s view from the front line. I have worked on several projects, including an audit of a company’s IT ahead of a migration from one data centre to another. In three cases, no documentation existed; in the fourth, documentation was scattered around in various places.

Data Centre migrations

An IT audit focusing on a data centre migration project aims to ensure the process is well-planned and executed to minimise risks, guarantee operations and data integrity continuity, and adhere to relevant standards and regulations. This article introduces the data centre migration audit concept and what it entails.

Documentation Required

The project will require several documentation types. As the project rolls on,  the project managers will develop their documents, such as progress spreadsheets. As a Technical Author, our focus is on the following documentation:

Profile documents – these are recommended if there is little to no documentation in existence. These documents contain high-level information. You will need one per server and list all the information such as users, dependencies, DR requirements, what it hosts, data flows In/Out and much more. I can supply a full list on request.

Operating Documents: These contain Profile information plus more granular information. The receiving team uses them as comprehensive information backup and must be stored in an accessible location.

Installation Documents – these provide valuable installation processes using the company’s configurations. These must also be stored in an accessible location.

Knowledge Transfer – to ensure everyone reads from the same page, collects knowledge from SMEs and shares it in an accessible location.

Purpose of the IT Audit in Data Centre Migration

  • Risk Assessment: To identify and assess risks associated with the migration, including:
      • data loss,
      • downtime,
      • security vulnerabilities, and
      • compliance issues.
  • Process Evaluation: To ensure that the migration process follows
      • organisational policies,
      • including project management,
      • change management, and
      • quality assurance.
  • Verification of Data Integrity and Security: To verify:
      • data integrity
      • implement security measures for data protection
  • Compliance Check: To verify adherence to relevant regulations and standards (e.g., GDPR, HIPAA, ISO/IEC 27001) that may impact the migration process.
  • Post-Migration Review: To evaluate the success of the migration in terms of meeting its objectives, including:
    • performance benchmarks,
    • cost-effectiveness, and
    • achieving planned benefits.

Critical Components of the Audit Process

  1. Pre-Migration Planning: Evaluating the thoroughness of the migration strategy, including:
    • assessing the current data centre’s architecture,
    • the migration’s Scope, and
    • the target environment’s readiness.
  1. Implementation Review: Analysing the execution of the migration to ensure it aligns with the following:
    • planned procedures,
    • project timelines, and
    • This includes reviewing the technical approaches, such as
    • data replication,
    • network reconfiguration, and
    • application migration strategies.
  1. Security Measures: Assessing the security protocols implemented before, during, and after the migration to safeguard data and infrastructure. This encompasses access controls, encryption, and security monitoring tools.
  2. Data Integrity Verification: Ensuring that data transferred during the migration is accurate, complete, and unchanged. Techniques such as checksum verification and data reconciliation are part of this process.
  3. Business Continuity and Disaster Recovery (BC/DR) Planning: Reviewing the effectiveness of BC/DR plans in the context of the migration, including the ability to recover data and maintain operations in the event of a failure.
  4. Post-Migration Validation: Conducting a thorough review after the migration to ensure that all systems operate as expected in the new environment. This includes performance testing, functionality verification, and ensuring that you achieve the migration objectives.
  5. Documentation and Reporting: Reviewing the completeness and accuracy of documentation related to the migration process, including planning documents, execution records, and post-migration evaluations. The audit will conclude with a detailed report highlighting findings, recommendations, and any identified issues.

Managing the Audit Process

    • Stakeholder Engagement: Involving critical stakeholders throughout the audit to ensure alignment and address concerns.
    • Use of Tools and Technologies: Leveraging specialised tools for data migration, security assessment, and project management to facilitate a thorough audit.
    • Expertise: Engaging with IT auditors with experience in data centre migrations and understanding the technical, operational, and compliance aspects of such projects.

Preparing for an IT audit involves a comprehensive review and documentation of your organisation’s IT infrastructure, policies, and procedures. The goal is to ensure your IT environment aligns with best practices, legal and regulatory requirements, and industry standards. Here’s a step-by-step guide on how to prepare for an IT audit focusing on documenting the network, servers, data flows, and disaster recovery (DR) outlines:

Understand the Audit Scope and Objectives

    • Identify the Type of Audit: an internal or external audit and the standards or guiding regulations (e.g., ISO/IEC 27001, GDPR, HIPAA).
    • Define the Scope, including specific systems, processes, or locations.

Assemble a Core Team

    • Select a diverse team of subject matter experts (SMEs) from different areas of your IT environment (network, server administration, data management, security, disaster recovery).
    • Designate a project manager with strong organisational and communication skills to lead the documentation effort.
    • Overseas Infrastructure: If the company has European offices, make contingencies for language barriers.

Designate a Point of Contact (POC)

    • Choose a POC fluent in English and possibly other languages spoken by team members to manage all communications effectively.
    • This person should have a good technical understanding and excellent communication skills to bridge language or technical gaps.

Consider Direct Meetings

    • If feasible, arrange for technical authors, or project leads to meet with overseas colleagues in person.
    • Direct interactions can foster better understanding, clear up ambiguities, and build stronger team cohesion.

Kickoff Meeting

    • Hold a kickoff meeting to outline the documentation project’s goals, process, and importance.
    • Use clear, simple language and visual aids to ensure understanding across language barriers.
    • Discuss the need to create a high-level profile document.

Document Collaboration

    • Utilise collaborative tools like shared documents, diagrams, and project management software that support comments and revisions.
    • Ensure the tools chosen are accessible and user-friendly for team members with varying technical expertise and language proficiency levels.

Collect Basic Information

Start by collecting high-level information about the IT infrastructure to create the profile document:

    • Network architecture: Outline the basic network design, including principal components like routers, switches, firewalls, and connectivity layout.
    • Servers and devices: List critical servers, their roles (e.g., web server, database server), and other critical devices.
    • Data flows: Identify central data flows within the network, highlighting the sources, destinations, and data processing stages.
    • Disaster recovery (DR) outlines: Provide a brief overview of the existing DR strategies.

Document the Network

    • Create or Update Network Diagrams: Include all network segments, connections, and critical devices (routers, switches, firewalls).
    • Identify Critical Assets: Mark systems that store, process, or transmit sensitive information.
    • Network Segmentation: Document how the network is segmented, especially areas with sensitive data.
    • Document Servers and Systems
    • Inventory: List all physical and virtual servers with their roles, operating systems, and critical applications.
    • Configuration Standards: Document the configuration standards for each type of server.
    • Access Controls: List access control measures in place for each server.

Document Data Flows

    • Data Flow Diagrams: Create diagrams showing how data moves through your systems, highlighting where data is stored, processed, and transmitted.
    • Data Classification: Document data classification (e.g., public, confidential, sensitive) and the controls in place to protect it based on its classification.
    • Third-Party Data Sharing: Document any data shared with or received from third parties, including the controls and agreements in place.

Use Visual Aids

    • Create simple diagrams and charts to visualise the network layout, data flows, and server organisation.
    • Visual aids can be crucial for overcoming language barriers and ensuring accurate understanding across teams.

Schedule Regular Updates and Reviews

    • Set up regular meetings or video calls with the core team and other SMEs to review the progress, clarify doubts, and validate information.
    • Use these sessions to address any misunderstandings or language-related issues promptly.

Create a Glossary

    • Develop a glossary of terms and acronyms used in the documentation to ensure everyone understands the terminology clearly.
    • This team members for whom English is a second language.

Document Disaster Recovery

    • Document Disaster Recovery (DR) Plans
    • DR Strategies: Outline strategies for data backup, recovery sites, recovery point objectives (RPOs) and recovery time objectives (RTOs).
    • DR Procedures: Document detailed DR procedures for different scenarios (e.g., data breach, natural disaster).
    • Testing Records: Include records of DR plan testing, issues identified, and corrective actions taken.

Review Policies and Procedures

    • Ensure all IT policies and procedures are up-to-date and compliant with relevant standards and regulations, including access control policies, data protection policies, and incident response plans.

Review and Feedback Cycle

    • Implement a thorough review and feedback cycle involving all SMEs to ensure the accuracy and completeness of the documentation.
    • Be open to feedback and willing to make adjustments based on insights from team members with different perspectives.

Conduct Internal Assessments

    • Perform a self-assessment to identify gaps in documentation, policies, or procedures.
    • Use checklists or auditing tools to simulate the audit process.

Training and Knowledge Transfer

    • Conduct training sessions to review the documents and ensure everyone understands the content.
    • Use these sessions to refine the documentation further based on questions and feedback.

Conclusion

An IT audit for a data centre migration is critical in ensuring that the migration is executed effectively and securely and complies with all relevant requirements. By systematically evaluating each migration phase, organisations can proactively mitigate risks, address potential issues, and ensure a smooth transition to the new environment.

 

Navigating Resistance to Change: The Power of Experience

Introduction

As a technical author with 25 years of experience, I have worked with the best and worst of people. I have encountered and survived complex individuals in various roles. 

I possess the ability to perceive people’s reactions to my proposals, which has proven invaluable. Even with my expertise, suggesting a complete transformation and changing the current setup can be challenging.

This article emphasises the importance of continuous change, trusting your instincts, and overcoming resistance to changing established procedures.

    1. The Power of Instincts: Refrain from undervaluing your intuition or gut feelings in professional settings. Your instincts can play a vital role in decision-making. You can identify the best ways to deliver solutions by reading people and their reactions. If it turns toxic, walk away and preserve your sanity and reputation.
    2. Do not overlook the value of experience, a precious commodity. Over 25 years, I have encountered diverse scenarios, learned from success and failure and refined my techniques. My perspective from experience lets me get on with the job and find solutions.
    3. In today’s fast-paced digital world, document management is constantly evolving. New tools, technologies, and methodologies emerge, offering greater efficiency and effectiveness in handling information. We must stay up-to-date with these changes and maintain our relevance in the industry to deliver optimal results for your audience.
    4. Understanding the psychology of words is crucial for effective technical writing. It involves tailoring information to meet your target readers’ needs, expectations, and cognitive processes. Creating content that engages readers requires identifying their frustrations and preferences.
    5. Embracing Continual Progression is the key to staying relevant in a dynamic industry. Remain open to adopting new tools and methods to enhance content creation and management. Change can improve efficiency, quality, and audience satisfaction despite stakeholder resistance.
    6. Overcoming resistance to change is natural in professional environments. Managers refrain from using new solutions because they perceive facing fresh problems. To overcome this resistance, consider the following strategies:
  • Please explain how the proposed changes will benefit the company, including how they will align with business goals, increase efficiency, and improve the user experience.
  • Practical solutions can gain broad acceptance by establishing trust.
  • Involve stakeholders in decision-making, seeking input and addressing their concerns or apprehensions.
  • Provide ongoing support to ease the transition and ensure everyone is comfortable with your solution.

Conclusion:

Your experience as a technical author has given you valuable written communication skills.

  • To introduce changes into a stagnant environment, trust your instincts and keep progressing.
  • Communicate the benefits to stakeholders in overcoming resistance to change and lead towards a more efficient and compelling solution. 
  • Embrace the power of your experience, and let it guide you as you navigate the ever-evolving world of technical authoring.