Manual proofreadingProofreading & Copy Editing

Proofreading of user manuals and technical documentation

Delivery from 1 dayRevisions includedQuality check
Packages
Payment protectionDetails
  • Revisions within the package are free.
  • If you do not respond within 3 days of delivery, the work is accepted automatically.
Order · $25

The money is reserved when you pay and released only once you accept the work.

Proofreading of user manuals and technical documentation

Example result

Example for the Standard package

Proofreading: annual report of a community garden association

Before and after (excerpt)

Before:

This year the garden welcomed 23 new members, and our waiting list have grown to 41 familys. Thanks to a council grant of £2,400 we replaced the old shed, it's roof had been leaking since 2023. Volunteers put in over 1.200 hours, a new record! The composting area was moved behind plot 14, which means the paths along plots 12-16 is now clear for wheelchairs. Special thanks goes to Margret Hale who organised the Spring Plant sale.

After:

This year the garden welcomed 23 new members, and our waiting list has grown to 41 families. Thanks to a council grant of £2,400, we replaced the old shed; its roof had been leaking since 2023. Volunteers put in over 1,200 hours, a new record! The composting area was moved behind plot 14, which means the paths along plots 12–16 are now clear for wheelchairs. Special thanks go to Margaret Hale, who organised the spring plant sale.

List of changes (excerpt)

#ParagraphWasNowType
12waiting list have grownwaiting list has grownGrammar: agreement
22familysfamiliesSpelling
32grant of £2,400 wegrant of £2,400, wePunctuation
42shed, it's roofshed; its roofPunctuation; its/it's
521.200 hours1,200 hoursNumber format
62plots 12-16 isplots 12–16 areDash in range; agreement
72thanks goesthanks goGrammar
82Margret HaleMargaret HaleName: spelled "Margaret" on p. 1 and p. 4
92Spring Plant salespring plant saleCapitalisation, as elsewhere in the report

Consistency check across the whole report

  • Names: "Margaret Hale" (4 times), "Tom Okoye" (3), "Priya Shah" (2), all now spelled the same way everywhere
  • Organisation name: "Elm Street Community Garden" used in full the first time, then "the garden"; 3 cases of "Elm St. Garden" changed
  • Spelling: British throughout ("organised", "colour", "programme"); 7 American forms changed
  • Numbers: thousands with a comma, ranges with an en dash; amounts checked against the finance table on page 5, all match

Not changed (for you to decide)

  • Paragraph 6 says "nearly 50 volunteers"; the table on page 5 lists 46. Both can be correct, so we left the wording.
  • "Potluck" appears both with and without a hyphen in quotes from members; quotes were kept as written.

Total: 2,684 words checked, 57 corrections.

Client: Elm Street Community Garden, a volunteer-run association with 80 members Text: the 2,700-word annual report for members and the local council Brief: fix errors only, keep the friendly voice; use British spelling; plot numbers and amounts must stay exactly as given

The client and all details are made up.

About this service

In a manual, the reader follows every word literally, so a button called "Save" in step 3 and "Apply" in step 5 causes real confusion. We proofread user guides, installation instructions and help articles for spelling, grammar and punctuation, and keep UI labels, part names, warnings and step numbering consistent. Code snippets, commands and file paths are left exactly as you wrote them.

What is included

  • What you getCorrected documentation with a list of changes; from Standard also a list of the terms and UI labels as used in the text. On the order page and as a Word (.docx) file.
  • Consistent UI labelsOne name for each button and menu
  • Step numberingNo gaps or repeats
  • Warnings and notesSame wording style throughout
  • Code left untouchedCommands and paths kept as written
  • Terms listFrom Standard: terms as used

How it works

  1. 1
    BriefYou send the manual and term list
  2. 2
    ProofreadingWe fix errors and align terms
  3. 3
    DeliveryYou get clean text and notes

What we need from you

The manual pasted or attached as a PDF with a text layer or Word file, the product name and, if you have one, your list of approved terms.

We will ask you:

  • What product does the manual cover?
  • Do you have a list of approved terms or UI labels?
  • Do you follow a style guide?
  • Which language variant should we follow?

Compare packages

PackagesBasicShort guide$12StandardUser manual$25PremiumDocumentation set$45
Deadline1 day2 days3 days
Revisions123
Lengthup to 1,000 wordsup to 3,000 wordsup to 7,000 words
Terms listNoYesYes
List of changesYesYesYes
Order BasicOrder StandardOrder Premium

Payment protection

You pay when you order, but the money is released only for accepted work.

  • Fixed priceThe package price does not change after you pay.
  • The money is reservedWhen you pay, the amount is only reserved. It is released to the service once you accept the work.
  • Checked before deliveryEvery result goes through a quality check before it reaches you, and you see it on the order page before accepting it.
  • Free revisionsAsk for changes within your brief as many times as the package allows.
  • Acceptance after 3 daysIf within 3 days of delivery you neither accept the work nor ask for changes, it is accepted automatically. If you write in the order chat after delivery, the order waits; once we answer, we may start the 3 days again and will say so in the chat.
  • Redo or a full refundIf the result does not match your brief and the revisions did not fix it, or the work takes more than twice its deadline, write in the order chat: we will redo the work or refund the payment in full.
How it works →

Questions and answers

Will you check that the steps actually work?

No, we cannot run your product. We flag steps that contradict each other or refer to a missing item.

Do you change technical terms?

Only to make them consistent with your approved list or with the form you use most often.

Can you work with screenshots in the manual?

Text inside images is not read from a PDF. If labels in screenshots matter, attach the screenshots as pictures too.

Packages
Order · $25· 2 days