KomuraSoft LLC
Contact
Menu

Word Manual Writing Basics - Bad Examples and How to Fix Them

· Updated: · · Word, Manual Writing, Documentation Design, Business Improvement

Revision history (1 updates, last updated Sep 1, 2026)

A log of the changes made to this article. Where a pre-update version was archived, it stays readable at a permanent DOI link.

Retranslated as a full translation of the Japanese original. The previous English version was an abridgement that carried only part of the source, so sections, tables, Mermaid diagrams, figure captions and FAQ entries were missing. All of them have been restored to match the Japanese original, and the technical claims are the same as in the Japanese version. Read the version before this update (DOI: 10.5281/zenodo.21614599)
First published
Cite this article(DOI: 10.5281/zenodo.21614598)

This article is archived on Zenodo. Below are both the DOI that always resolves to the latest version and the DOI pinned to the version you are reading.

Go Komura (2026). Word Manual Writing Basics - Bad Examples and How to Fix Them. KomuraSoft LLC. https://doi.org/10.5281/zenodo.21614598 https://comcomponent.com/en/blog/2026/04/08/000-word-manual-basics/

DOI (latest version)
10.5281/zenodo.21614598
DOI (this version)
10.5281/zenodo.22220411

Operation manuals, work instructions, maintenance procedures, internal runbooks. What pays off later in documents like these is not writing skill itself, but whether you are using Word as a tool for tidying up appearances and nothing more.

Approaches that look fast at first:

  • building headings out of nothing but bold and font size
  • lining things up with repeated spaces and Tabs
  • pressing Enter over and over to reach the next page
  • typing the table of contents and page references by hand
  • mixing revision requests into the body as red text

Once these creep in, the document breaks with every revision.

This article lays out the Word basics that genuinely matter when writing a manual, in the form of bad patterns paired with best practices.

Who this is for, and the versions it assumes

Item Details
Intended reader Anyone currently building manuals by tidying up the appearance by hand. It is written so you can follow along even if you do not yet know what features Word has
File format A workflow with .docx as the primary format
Assumed application Word desktop (Windows). Ribbon names follow the Microsoft 365 wording
Differences in other versions Word 2024 / 2021 / 2019 all have every feature covered here. However, tab names and button positions can differ. In particular, on a narrow window the buttons on the References tab collapse behind an overflow chevron, and in some localized builds that tab carries a different name. If the Accessibility Checker button is not visible on the Review tab, open it from File > Info > Check for Issues1
Web version Basic editing works, but the procedures in this article assume the desktop version

When a ribbon name does not match what you see, search by feature name rather than by tab name. The feature names heading styles, numbering, table of contents, breaks, and track changes are the same in every version.

Table of Contents

  1. The conclusion first
  2. Do not turn Word into a tool for lining things up by hand
  3. Bad patterns and best practices at a glance
  4. Points that matter in practice (4.7 has the procedures for the five main features)
  5. The bare minimum for a manual-writing Word template
  6. Pre-distribution checks
  7. Summary
  8. References

In the diagram a solid line marks a relation that always holds and a dashed line marks a conditional one (the conditions are given per relation on the detail page). The full list of relations (21 in total, with evidence and certainty) and the definitions of the main concepts are collected on the knowledge map detail page (in Japanese). Data: JSON-LD / Turtle

1. The Conclusion First

Here are the conclusions up front. Four things pay off in manual writing.

  1. Let Word features own the structure Headings, numbering, the table of contents, references, and page control are managed with Word styles, fields, and breaks rather than typed by hand.

  2. Do not let whitespace own the alignment Spaces, repeated Tabs, and stacked blank lines break every time you make a fix. Use paragraph settings, indents, tables, and sections.

  3. Do not mix review into the body Revision instructions go into comments and tracked changes, not into red body text. That way it is clear what was actually settled in the final version.

  4. Update the automatic elements right before distribution Update the table of contents, page numbers, cross-references, and figure and table numbers all at once at the end. Check accessibility before producing the PDF.

2. Do Not Turn Word into a Tool for Lining Things Up by Hand

The most important thing in manual writing is separating appearance from structure.

For example, all of the following are inherently structure:

  • Chapters, sections, subheadings
  • Step 1, Step 2, Step 3
  • Figure 2-1, Table 3-2
  • See Chapter 4
  • No page number on the title page only
  • The revision history at each update

In fragile documents, though, every bit of that structure gets handled as an appearance tweak:

  • Enlarging the text so it looks like a heading
  • Typing 1. by hand
  • Lining things up with spaces
  • Pushing to the next page with Enter
  • Typing see page 3 as literal text

With this approach, fixing one spot breaks something somewhere else.

Word ships from the start with features for holding a document as structure: heading styles, tables of contents, paragraph settings, multilevel lists, headers and footers, section breaks, captions, tracked changes, the Accessibility Checker, and more. In a manual, simply using these basics eliminates a great deal of breakage.

3. Bad Patterns and Best Practices at a Glance

Item Bad pattern Best practice
Headings Build the chapter structure with bold plus font size only Use Heading 1 / Heading 2 / Heading 3
Alignment Line things up with spaces and repeated Tabs Use paragraph settings, indents, tab stops, and tables
Page control Push to the next page with repeated Enter Use page breaks and section breaks
Table of contents Type the TOC by hand Heading styles plus an automatic TOC
Step numbering Type 1. 2. 3. by hand Use numbered lists / multilevel lists
Headers and footers Enter them directly on every page Use headers / footers and page numbers
Figures and tables Paste the image and nothing else, no title Add captions, body explanation, and alt text
Revisions Leave red body text and color coding in place Review with tracked changes and comments
References Write see page 3 or the figure above by hand Use cross-references and field updates
Formatting rules The look differs from author to author Decide the template and styles first

The right-hand column of this table only names the features. Where to click in the ribbon is collected in 4.7. If this is the first you have heard of a given feature, reading 4.7 first and then coming back to 4.1 should make things clearer.

4. Points That Matter in Practice

4.1 Building headings out of nothing but bold and font size

Bad pattern Enlarging the text, making it bold, and settling for something that merely looks like a heading.

Why it hurts Word does not treat that line as a real heading. Navigating with the Navigation Pane becomes harder, and the line never appears in the automatic table of contents. From an accessibility standpoint too, appearance-only headings are a disadvantage.

Best practice Assign Heading 1 / Heading 2 / Heading 3 to chapters, sections, and subheadings. When you want to change the look, edit the style rather than touching the bold and font size of each individual line.

4.2 Lining things up with spaces and repeated Tabs

Bad pattern Filling the gap between an operation name and its description with spaces, pushing the version number to the right edge with repeated Tabs, stacking blank lines instead of setting paragraph spacing.

Why it hurts One extra character in the wording and it all falls apart. Font changes, added paragraphs, PDF conversion, and co-authoring all knock things out of line.

Best practice Let position and spacing be owned by paragraph settings, not by characters. Use indents, tab stops, spacing before and after paragraphs, and a table where one is warranted.

4.3 Breaking pages by pressing Enter repeatedly

Bad pattern Wanting the next chapter to start on a new page, so pressing Enter over and over to push it there.

Why it hurts The moment one line is added on an earlier page, everything shifts. Blank pages creep in, a title gets stranded on the previous page, and headers or footers switch at unintended places.

Best practice Use a page break at the start of each chapter, and a section break wherever the handling of page numbers or headers and footers needs to change. When something breaks, turn on the display and inspect it with the page breaks and paragraph marks visible.

4.4 Do not hand-type the TOC, the numbering, or cross-references

Bad pattern Building the TOC page by hand and retyping chapter names and page numbers every time. Typing 1. 2. 3. or 1.1 1.2 directly into the body. Writing see page 12 or see Figure 3 as literal text.

Why it hurts Every revision leaves something un-updated. It is easy to end up fixing only the page number while the heading name stays stale.

Best practice Build an automatic table of contents from the heading styles. Hold steps as a numbered list and the chapter and section hierarchy as a multilevel list. Hold references to figure numbers, page numbers, and chapter numbers as cross-references or fields, and update them all at once at the end.

4.5 Do not type headers, footers, and version numbers directly on each page

Bad pattern Entering the document name, version, and page number directly onto every page. Hand-adjusting the layout because the title page is supposed to be treated differently.

Why it hurts You forget to update the version, page numbers drift, and things fall apart the moment you want the appendix alone to use a different format partway through.

Best practice Move the document name, version, and page numbers into the header / footer. For a distinct title page use Different First Page; to switch per chapter or appendix, use section breaks together with turning off Link to Previous for the header / footer.

4.6 Keep tracked changes, comments, and figures and tables separate

Bad pattern Leaving notes in red text such as fix this, unverified, or needs discussion, and letting them ride into the final version. Pasting a full-screen screenshot with no figure number and no explanation.

Why it hurts It becomes impossible to tell what is body text and what is a note from mid-review. It is also how review traces end up in the final version.

Best practice Put the edits themselves in tracked changes and any discussion or instruction in comments. Give figures and tables a caption, and set alt text where it is needed.

How to place images and screenshots, automatic figure numbering, and deleting cropped-away regions are enough material for an article of their own, so they are split into the follow-up, How to place images, figures, and screenshots in a Word manual without breaking the layout. If your manual is figure-heavy, read that one next.

4.7 The shortest path to the five main features

Everything so far has been about what to do. Here is where to actually click, for five features. First, the overview.

Feature Shortest path Shortcut
Heading styles Put the cursor on the line you want as a heading and pick Heading 1 from the style gallery on the Home tab2 Ctrl + Alt + 1 / 2 / 33
Numbered list Select the step lines and click Numbering in the Paragraph group on the Home tab4 -
Automatic TOC Click where you want the TOC and choose References tab > Table of Contents > Automatic Table2 -
Section break Put the cursor where the switch should happen and choose Layout tab > Breaks > Next Page5 A plain page break is Ctrl + Enter3
Track changes Turn on Track Changes on the Review tab. Accept and reject from the Changes group on the same Review tab6 Ctrl + Shift + E3

A few notes on each, in order.

1. Assign heading styles

  1. Put the cursor on the chapter title line (there is no need to select the whole line).
  2. Pick Heading 1 from the style gallery on the Home tab.2
  3. Use Heading 2 for sections and Heading 3 for subheadings.
  4. When you want to change the look, do not touch the line itself: right-click the style name, choose Modify, and edit the formatting there. Fix it in one place and every line with that style follows.

2. Use a numbered list for steps

  1. Select all the step lines at once.
  2. Click Numbering in the Paragraph group on the Home tab.4
  3. When you want the chapter and section hierarchy numbered as well, choose a format that is linked to the heading styles from Multilevel List in the same group.

Simply giving up typing 1. by hand makes reordering and inserting steps dramatically easier.

3. Insert an automatic table of contents

  1. Finish applying the heading styles from step 1 first. The TOC only picks up lines that carry a heading style, so if this is not done you get an empty TOC.
  2. Click where the TOC should go, normally the top of the document.
  3. Open References tab > Table of Contents and choose Automatic Table.2
  4. After a revision, select the TOC and run Update Table. How to update the whole document at once is covered in 6.1.

4. Choose between a page break and a section break

  1. If you only want to start on the next page, insert a page break with Ctrl + Enter.3
  2. When you want to change how page numbers are applied, the contents of the header or footer, or the page orientation partway through, choose Layout tab > Breaks > Next Page at that position.5
  3. Section breaks come in Next Page, Continuous, Even Page, and Odd Page. In a manual it is almost always Next Page.5
  4. If you lose track of which one is in there, turn on Show/Hide in the Paragraph group on the Home tab and the break type is displayed inline in the body (Ctrl + Shift + 8; the 8 on the numeric keypad does not work).3

5. Review with tracked changes

  1. Before review starts, turn on Track Changes on the Review tab (Ctrl + Shift + E).63
  2. From then on, deletions, insertions, and formatting changes are recorded. Nobody has to type anything in red.
  3. Questions and needs-checking notes do not go into the body; enter them as comments.
  4. Finalize from the Changes group on the Review tab, accepting or rejecting one item at a time.6
  5. Before distribution, always confirm that no tracked changes or comments remain (see 6.2).

5. The Bare Minimum for a Manual-Writing Word Template

You do not need an elaborate template right away. To begin with, this much is enough.

Element Use Minimum rule
Document title Cover and opening title Carry the document name, version, creation date, and revision date
Heading 1 Chapter Included in the automatic TOC
Heading 2 Section Included in the automatic TOC
Heading 3 Subheading Use only when needed
Normal Body Base text
Numbered list Steps Use for operating procedures
Bulleted list Supplements Use for enumerating conditions and cautions
Figure caption Figure numbers Figure 1, Figure 2…
Table caption Table numbers Table 1, Table 2…
Header / footer Shared information Document name, version, page number

Deciding the operating rules to roughly this level as well makes everything afterwards much easier.

  • The master copy is .docx
  • Distribution is as PDF
  • Revisions use tracked changes
  • Update fields before distribution
  • Run the Accessibility Checker before distribution

6. Pre-Distribution Checks

Before turning the manual into a PDF, these are the minimum things worth looking at.

6.1 Update every field

Select the whole document with Ctrl + A and update the fields with F9.3 This cuts down on stale entries in the TOC, page numbers, cross-references, and figure and table numbers.

6.2 Clear out tracked changes and comments

Confirm that no mid-review changes or comments are left behind. Watch for the case where they were merely hidden and are still in the file.

6.3 Check the heading levels

Look at whether the chapter structure is consistently Heading 1 / 2 / 3. If it is not, the TOC and the navigation fall apart.

6.4 Check images and tables

Confirm that figures and tables are numbered, that images are not oversized, and that the body explains what the reader should be looking at.

6.5 Run the Accessibility Checker

Run the Accessibility Checker and confirm there are no problems with headings, alt text, contrast, table structure, and so on. If PDF distribution is the plan, getting this right on the Word side first is the safer route.

7. Summary

The thing you most want to avoid when building manuals in Word is holding the structure by hand too.

  • Headings via styles
  • Steps via the numbering features
  • The TOC automatic
  • Page control via page breaks and sections
  • Figures and tables via captions
  • Review via tracked changes and comments
  • References via cross-references
  • Updates and checks before distribution

In short: do not stop at using Word as a tool for typing characters, and instead use it as a tool for managing document structure.

Manuals show their differences not at the moment of writing but at the moment of fixing. A document that breaks with every revision is usually one whose Word fundamentals broke before its content did.

Put the other way around, just nailing these basics raises a document’s maintainability considerably. There is no need to aim for elaborate design at the outset. The practical starting point is to stop doing these five by hand: headings, numbering, the table of contents, page breaks, and review.

8. References

  1. Microsoft Support, Improve accessibility with the Accessibility Checker ↩

  2. Microsoft Support, Create a table of contents ↩ ↩2 ↩3 ↩4

  3. Microsoft Support, Keyboard shortcuts in Word ↩ ↩2 ↩3 ↩4 ↩5 ↩6 ↩7

  4. Microsoft Support, Create a bulleted or numbered list ↩ ↩2

  5. Microsoft Support, Insert a section break ↩ ↩2 ↩3

  6. Microsoft Support, Track changes in Word ↩ ↩2 ↩3

Related Articles

Recent articles sharing the same tags. Deepen your understanding with closely related topics.

Related Topics

These topic pages place the article in a broader service and decision context.

Where This Topic Connects

This article connects naturally to the following service pages.

Frequently Asked Questions

Common questions about the topic of this article.

What should I watch out for first when building a manual in Word?
Separate appearance from structure. Chapter organization, step numbering, the table of contents, page control, and references should be owned by Word features rather than by bold text and repeated spaces. Concretely: headings via styles, steps via numbered lists, the table of contents via an automatic TOC, page control via page breaks and section breaks, and references via cross-references. A document tidied up by hand breaks with every revision.
Why is it wrong to make headings out of nothing but bold and font size?
Because Word does not treat that line as a real heading. Navigating with the Navigation Pane becomes harder, and the line never appears in the automatic table of contents. Appearance-only headings are a disadvantage for accessibility too. Assign the Heading 1 / Heading 2 / Heading 3 styles to chapters, sections, and subheadings, and when you want to change the look, edit the style rather than each individual line.
What goes wrong if I break pages by pressing Enter repeatedly?
The moment one line is added on an earlier page, everything shifts. Blank pages creep in, a title gets stranded on the previous page, and headers or footers switch at unintended places. The basic rule is a page break at the start of a chapter, and a section break wherever the handling of page numbers or headers and footers needs to change. When something breaks, turn on formatting marks and inspect it.
What should I check before distributing a manual?
Five things at minimum. Select the whole document with Ctrl + A and press F9 to update fields, so the TOC, page numbers, cross-references, and figure and table numbers are not left stale. Confirm that no tracked changes or comments remain. Look at whether the heading levels are consistent. Check the numbering and size of figures and tables. And run the Accessibility Checker to find problems with headings, alt text, contrast, and table structure.

Author Profile

Profile page for the article author.

Go Komura

Representative of KomuraSoft LLC

Focused on Windows software development, technical consulting, and investigations into failures that are difficult to reproduce.

Contact
Back to the Blog