Client Spec Drafts
Let your customers write and edit draft specs on the portal's Specs page, in categories you open to them, discuss them with your team in each draft's comment thread, then review and publish them from the article editor.
On this page
What client spec drafts are for#
Sometimes the person who knows exactly what is needed is the customer. Client spec drafts let a signed-in customer write that down themselves, in your Knowledge Base, instead of describing it across a long ticket thread. They write a draft spec on the portal's Specs page; your team sees it arrive in Manage articles, shapes it, and publishes it when it is ready.
A client's draft is private to their own company. Other companies never see it, and nothing a client writes reaches the Help center until someone on your team publishes it.
Client drafts are off everywhere until you open a category to them.
Opening a category to client drafts#
On Manage articles, open the category's ⋯ menu and choose Edit (or create a new category). Switch on Clients may submit drafts here and click Save.
- The switch is off by default for every category, new and existing.
- Each category has its own setting. Opening a category does not open its subcategories; switch on each one you want.
- The category must also be customer-facing: set to Portal (customers), with no Internal category above it. A category hidden from customers accepts no client drafts, whatever its switch says.
Changing the switch needs the Publish knowledge-base articles permission, like every other category change. See Organizing with categories.
What your customers see#
Once at least one category is open, the portal's menu shows Specs, and the Specs page has a Your drafts section with a Write a new spec button. When more than one category is open, the customer first picks one under Category for the new spec. If no category is open, the section does not appear at all.
Your drafts lists every draft spec from the customer's company, with when it was last updated. The customer's own drafts are marked Written by you. Until the company has written one, the section reads Your company has no spec drafts yet. The portal's Home page also counts the company's specs by stage under Specs in progress.
Writing a spec#
Write a new spec opens the spec editor, with a Title, the Spec itself and attachments.
- Formatting: bold, italic, two heading sizes (Heading and Subheading), bulleted and numbered lists, and links. Formatting your team adds later in the full article editor, such as tables, images, code, quotes and video, is kept when the customer edits the spec again.
- Saving: Save draft saves at any time. The spec also saves itself 30 seconds after the first unsaved change. A spec needs a title before it can save: Give the spec a title before saving.
- Leaving: if there are unsaved changes, the portal asks You have unsaved changes. Leave without saving? before it lets the customer go.
- Attachments: files are virus-scanned, exactly as ticket uploads are, and are linked at the end of the spec when it is saved.
- Category: chosen when the spec is first saved. After that it shows as text; only your team can move the spec to another category.
Editing together#
Anyone signed in from the same company can open a draft from Your drafts and edit it, not only the person who started it. Every save is kept as a version in the article's history, under the name of the person who saved it.
If two people save the same spec at once, the second is told Someone else changed this spec since you opened it. Their own text is kept on the page under Your unsaved text, so nothing is lost. They choose Reload the latest version, then add their changes back.
Discussing a draft#
Every saved draft has its own Comments thread in the portal, below the spec, whether or not customer comments are switched on for published articles. Everyone signed in from the customer's company can read it and comment, and your team answers from the article editor's Comments panel, exactly as on a published article (see Customer comments on articles):
- your team's public comments appear in the draft's thread, shown as Support;
- your team's internal notes never reach the portal, so you can discuss a client's draft among yourselves beside their conversation.
A customer can pin a comment to words in the draft: select the words, click Comment on this, write the comment and click Post comment, just as on a published article. If the spec has unsaved changes, it is saved first, so the comment is pinned to the words the server has; if that save fails, the portal says Save your changes to the spec first, then post again. Pinned words are highlighted in the spec. Where the spec is shown read-only, clicking them opens their comment; while the customer is editing it, Show in text on the comment finds its words.
A customer's save keeps every pin your team or their colleagues placed, as long as the pinned words are still in the spec. When the words are deleted or rewritten, the comment stays and says Passage removed.
When a draft stops being editable#
A customer can edit a draft only while it is still a client draft in an open category. It becomes read-only in the portal, with This spec can no longer be edited here, when your team:
- publishes it. This ends client editing for good: unpublishing it later does not give it back to the customer.
- switches off the category's Clients may submit drafts here, or makes the category (or one above it) Internal.
- archives it, or sets its visibility to Internal.
- changes which companies it is shared with.
What your team sees#
A client's draft is an ordinary draft article in Manage articles, with the customer shown as its author. Look under the Specifications tab when its category holds specs, and under External Articles otherwise:
- The Author column shows the customer's name with a Client chip.
- The editor shows Written by name (client).
- The History panel names the customer on every version they saved. See Article history and restore.
The people who can see other members' drafts can see a client's draft too, and editing it follows the rules for editing someone else's article. See Knowledge Base permissions. Your edits are what the customer sees the next time they open the spec, so you can tidy a draft together before it goes live.
Being told when a new draft arrives#
When a customer saves a new spec, everyone who holds Publish knowledge-base articles gets an in-app notification: A client submitted a new spec draft in category. It names only the category, never the customer or what they wrote, and opening it takes you to the article. Later saves to the same draft send no further notifications.
Publishing it#
Review the draft like any other, set its audience, and click Publish. From then on it is a normal article: the customer can read it in the Help center if its audience allows, but can no longer edit it.
Stages and approval for specs#
Two more tools help you run specs through to agreement:
- Stages label where a spec has got to, such as In review or Ready for development. Your team sets the stage in the article editor, on a client's draft as on any article, and the customer sees it as a badge on the Specs page and on the spec page. Customers cannot change it, and moving a draft between stages does not affect their ability to edit it.
- Approval for published changes applies once a spec is published: in a category with approval switched on, any later edit by your team is held as a proposed change until a publisher approves it. Client drafts are unpublished, so they are never held for approval.
Privacy: erasing and merging customers#
Client drafts follow the customer's record in Service Desk:
- Erasing a customer (Anonymize… on the requester) replaces the titles and text they wrote in unpublished drafts with [Removed], in every version in the history, and removes the draft's title from your team's notifications. The words quoted on comments pinned to those drafts are cleared too, so a quote is never the last copy of what they wrote. Published articles keep their content.
- Merging two requesters moves the drafts and versions written by the requester being merged away to the one you keep.
Related#
- The customer Help center: what customers see in the portal.
- Organizing with categories: creating categories and their settings.
- The article lifecycle and URLs: draft, published and archived.
- Knowledge Base permissions: who can edit and publish.