THIS IS A TEST

This is the Overview section, a short context-setting intro of 2–4 sentences. Explain who this article is for (end-users, sysadmins, resellers) and what problem this article solves. Include the exact error message if one exists, and describe the symptom from the perspective of an end user. This will help the reader quickly confirm they’re in the right place.

Mention the relevant product name (for example, PaperCut Hive, PaperCut MF, Mobility Print etc.) and feature.

Optionally, summarize why the customer’s issue happens. Keep each cause short and specific.

• Most common likely cause
• Less common but possible cause
• Environment or configuration cause

How to fix the problem

Provide step-by-step instructions in the order they should be done. Use numbered steps. Keep each step to one main action and describe the result of each step.

Start by saying where to go, then what to do there. Bold the things the user has to type or click to make the article easy to scan.

For example:

1. On the Windows print server, press Windows key + R. The Windows run dialog box is opened.
2. Type printmanagement.msc, and press Enter. Print Management console is displayed.
3. Right-click the printer you want to manage and select Properties. The properties dialog for the printer is opened.
4. And so on..
5. The last step should always explain how to verify the procedure’s success. Describe a simple test and the expected result.

Include screenshots only if they make the step clearer.

Further help

Describe what to do if the above steps didn’t work. How should they get help? What log files or other details would they need to provide?

• Check the Known Issues page to see if your issue may be listed.
• Enable debug mode, reproduce the issue, and then download the diagnostic bundle to share with your support contact. See How to collect Application Server Debug Logs
• Make a note of key details (time, username, device IP, make/model/firmware).
• Get your support request started through our Support Portal .

Related articles (optional)

This is the last section in your article. Link only to genuinely helpful related topics.

Choose articles that solve closely related problems or required setup.

• How to create, edit & delete Knowledge Base articles (KBs) and Manual pages (manuals)
• Peer Review Process
• How to add a GIF to your article
• Categories in the KB
• Glossary

Level up your writing

Use these tools to take your documentation to the level required for publishing.

• Grammarly — Install the Grammarly Chrome plugin to speed up your writing by catching grammar and spelling issues while you actually write. Our enterprize plan also checks terminology and capitalization against our PaperCut Glossary.
• PaperCut writing and style guidelines — Follow our PaperCut writing and style guidelines in Confluence for tone, structure, and formatting. See: Top <tech> writing tips — Cheat Sheet .
• PaperCut technical writing gem — Use the gem to turn rough notes into a draft with proper structure, formatting, capitalisation, and glossary-correct terms. While it helps with formatting and first-pass review, it DOES NOT verify technical accuracy or replace testing.
• Peer review — Ask for review or input in #ama-documentation-manuals-kbs-etc . Apart from minor updates (a small sentence or paragraph update), all KBs need a second set of eyes for technical accuracy and general writing feedback. This is especially necessary for major changes and new articles.

Select categories

There are two levels of KB category pages. In the left bar, select a Main Category and a Category for your page. This helps your page get discovered by users and search engines.

As an example, the article Capturing a Windows Spool File has one of each category: How-to Articles and Print Jobs .

For more information, see Categories in the KB .