Tag: ISO 9001

Don’t Overlook the Technical Author: A Question for Project Managers

Project managers often bring technical authors in too late. Experienced technical authors can reduce delivery risk by shaping documentation early—supporting IT audits, ITIL-aligned processes, ISO 27001/ISO 9001 controls, disaster recovery packs, incident and change management, and operations manuals. Know your technical author before you assume their limits.

Tweet
Pin
Share
0 Shares

Here is a question for project managers:

How many projects did you manage where the team treated the technical author as an afterthought or excluded them entirely?

It happens more often than it should. Project managers view documentation as something to “do at the end”, once the teams finish the proper work and the delivery pressure is at its peak.

That is when teams discover the cost of leaving documentation too late.

By the time the project is in closure mode, you have already missed the point where a technical author adds the most value.

The mistake: assuming the technical author is “just a writer”

Many project managers underestimate what an experienced technical author actually does. They think we:

      • only polish text,
      • rewrite technical material in plain English,
      • only fix formatting.

That is only one part of the job.

Technical authors understand IT operations and governance. They have documented services for years. This experience extends to audits. They know how to gather evidence.

What an experienced technical author may already know

A technical author may already have delivered documentation for:

      • IT audits and compliance preparation
      • Disaster recovery (DR) documentation
      • Operations manuals and runbooks
      • Incident, problem, and change management processes
      • Service transition documentation
      • Knowledge base and repository design
      • Information governance and document control
      • Data centre migration documentation
      • ITIL-aligned documentation structures
      • ISO 27001 and ISO 9001 aligned document frameworks

These are not theoretical skills. They come from being repeatedly embedded in delivery and operational environments across different organisations and clients.

The risk: documentation gaps that become delivery risks

When you exclude technical authors from early planning, projects often run into the same problems:

      • They discovered the documentation gaps late.
      • Missing operational detail that prevents handover
      • Inconsistent terminology and process steps
      • Rework caused by unclear ownership and review routes
      • Poorly structured repositories that no one can navigate
      • Evidence gaps that become audit risks
      • Last-minute “document sprints” that no one has time for

These issues are rarely “writing problems” but planning problems which are avoidable.

Know your technical author before you assume their limits

Every technical author has a unique history. Some come from engineering, some from software and infrastructure, some from compliance-heavy environments, and some from service operations.

You will not know what capabilities you have access to unless you ask.

Here is a simple, early-project habit that saves pain later:

Sit down with the technical author and establish what they’ve done before.

Ask questions like:

      • What types of projects have you supported?
      • What frameworks do you work with (ITIL, ISO 27001, ISO 9001)?
      • What operational documentation have you delivered (DR packs, ops manuals, runbooks)?
      • What documentation risks do you expect on a project like this?
      • What do you need from the team to avoid last-minute document chaos?
      • You may find they know more about documentation governance, operational readiness, and audit evidence than you expected.

Documentation is not an output. It is part of the delivery.

Documentation is not a box to tick at the end.

It is part of how projects:

      • reduce operational risk
      • pass audits
      • transfer knowledge
      • support teams
      • enable safe change
      • transition into BAU without firefighting

A technical author is not “just the person who writes things down”.

A strong technical author is often one of the few people on a project who thinks in terms of:

      • structure
      • lifecycle
      • traceability
      • usability
      • governance
      • evidence

Last point: never overlook the technical author

If you want better delivery outcomes, involve documentation earlier and treat it as a work stream with ownership and design—not a clean-up job.

Never overlook the technical writer.

Because the best technical authors are not just documenting your project.

They can make it work.

Have you ever consulted your technical author on previous deliverables to identify and reduce project risks?

Document Strategy vs Document Plan: Why Most Organisations Get It Wrong

Introduction

In the world of technical authoring and information management, people often use two terms interchangeably, but understanding your document strategy is key to approaching both effectively.

      1. Document strategy
      2. Document plan

They are not the same.

Confusing them is one of the main reasons documentation becomes reactive, inconsistent, and vulnerable to managerial interference.

If management treats documentation as administrative output rather than a governed asset, it will always sit at the whim of whoever speaks loudest.

This article explains:

      1. What a document strategy actually is
      2. What a document plan does
      3. Why governance matters?
      4. What must senior technical authors implement to protect documentation assets?

What is a document strategy?

A document strategy defines how documentation supports organisational objectives. It is not:

      • a list of deliverables.
      • a collection of templates.
      • a SharePoint structure.

It answers fundamental questions:

      • Why does documentation exist in this organisation?
      • What risk does it mitigate?
      • What decisions must it support?
      • What compliance obligations must it satisfy?
      • Who owns it?

In regulated environments, document strategy connects directly to standards such as

      • ISO 9001 (Control of Documented Information)
      • ISO/IEC 27001 (information security controls)
      • ITIL (service documentation and knowledge control)

If documentation is required for audit, certification, or regulatory compliance, you must govern it strategically.

What a proper document strategy includes

A credible document strategy defines:

1. Governance Model

      • Clear document ownership
      • Defined author vs reviewer vs approver roles
      • RACI alignment
      • Escalation routes

2. Lifecycle Control

      • Create → Review → Approve → Publish → Maintain → Retire
      • Mandatory review cycles
      • Version control standards
      • Archiving criteria

3. Classification and Security

      • Controlled vs uncontrolled documents
      • Public vs restricted
      • Security classification tiers

4. Architecture and Structure

      • Taxonomy
      • Metadata standards
      • Naming conventions
      • Document numbering schemas

5. Decision Framework

      • What qualifies as controlled documentation?
      • What does not?
      • When documentation is proportionate
      • When a knowledge article is sufficient

Without these elements, documentation becomes personality-driven rather than policy-driven.

What is a document plan?

A document plan is operational.

It applies the strategy to a specific project, programme or service.

Where strategy defines governance, the plan defines delivery.

It answers:

      • What documents are required?
      • Who is writing them?
      • When are they due?
      • What reviews are mandatory?
      • What approvals are needed?
      • How do they align with stage gates?

In complex programmes — such as digital transformation, DMS rollout, or security accreditation — a document plan ensures traceability and sequencing.

Without a document plan, documentation is:

      • Rushed at the end
      • Inconsistent across work streams
      • Duplicated across teams
      • Politically rewritten

Why Documentation Falls “at the whim of managers”

Documentation becomes unstable when:

      • There is no documentation policy
      • Templates are uncontrolled
      • Metadata is optional
      • No audit mechanism exists
      • No one owns lifecycle enforcement

In that vacuum, managers step in.

They introduce:

      • New templates
      • Personal preferences
      • Structural changes
      • Ad hoc requirements

The result is entropy.

Governance prevents that.

What technical authors must do beyond writing

Senior technical authors must move beyond content production.

They must act as:

      • Information architects
      • Governance stewards
      • Lifecycle controllers
      • Risk mitigators

Below are the controls that protect documentation assets.

1. Establish documentation governance

Create:

      • Documentation Policy
      • Document Control Procedure
      • RACI matrix
      • Change management workflow for templates

Ensure:

      • Template changes require approval
      • New document types require justification
      • eliminate uncontrolled versions

2. Enforce metadata and taxonomy

Metadata is not optional in mature environments.

Define mandatory fields such as:

      • Document Owner
      • Service Area
      • Security Classification
      • Review Date
      • Version Number

Implement enforcement within:

      • SharePoint libraries
      • Asite or DMS platforms
      • Controlled repositories

If you do not enforce metadata, the structure collapses.

3. Institute review discipline

Set:

      • Annual review cycles (minimum)
      • Risk-based review frequency
      • Automated reminders
      • Expiry flags

Outdated documentation creates audit exposure.

4. Run documentation audits

Introduction:

      • Quarterly sampling
      • Annual full audit
      • Traceability verification
      • Redundancy elimination

Without an audit, decay is inevitable.

5. Design templates that enforce structure

Most engineers and technicians do not read style guides.

They follow structure.

Well-designed templates:

      • Force styles
      • Control numbering
      • Embed guidance
      • Reduce formatting drift
      • Prevent structural inconsistency

Templates are governance tools disguised as formatting aids.

6. Define what not to document

Over-documentation creates noise.

A strong document strategy specifies:

      • What must you control?
      • What belongs in a knowledge base?
      • What remains in the service tools?
      • What is transient and disposable?
      • Clarity reduces clutter.

Document strategy maturity model

Organisations typically sit at one of these levels:

Level Description
Level 1 Ad hoc and personality-driven
Level 2 Template-based but uncontrolled
Level 3 Defined lifecycle and metadata
Level 4 Audited and measured
Level 5 Strategically aligned to risk and performance

Most organisations sit between Level 1 and Level 2.

A mature technical author moves them to Level 3 and beyond.

The critical distinction

      • Document Strategy = Governance + Risk Alignment + Structure
      • Document Plan = Delivery + Scheduling + Accountability
      • Ongoing Stewardship = Control + Audit + Discipline

Writing is only part of technical writing.

Control is the real work.

Final Thought

If A.N. Other can alter documentation at will, it is neither governed nor strategic.

And if it is not strategic, the user will not treat it as a corporate asset.