AssistCamp

Creating Your First Doc

A doc is a single documentation article. You create docs the same way you create a blog post in WordPress, using the block editor, with a few extra options in the sidebar that belong to AssistCamp.

Before you start

You do not need to create a knowledgebase or a category first. You can create a doc immediately and organize it later. That said, assigning a category while you write saves you a step.

Steps to create a doc

  1. In your WordPress admin, go to AssistCamp > Add New Doc.
  2. Type your doc title where it says Add title. Use the title your reader would search for, such as “How to reset your password”, not a vague label such as “Passwords”.
  3. Write your content in the editor below the title. Use heading blocks to break the doc into sections. AssistCamp uses your headings to build the automatic table of contents on the front end.
  4. In the right sidebar, open the Docs Categories panel and choose a category, or click Add New Category to create one on the spot.
  5. Still in the sidebar, open the Knowledgebases panel and choose a knowledgebase if you use them.
  6. Optionally add tags in the Docs Tags panel, add a short summary in the Excerpt panel, and click Set cover image to give the doc a header image.
  7. Click Publish.
  8. Click View to see the published doc on your site.

About the doc URL

Your published doc gets a web address based on your documentation slug and the doc title, for example yoursite.com/docs/how-to-reset-your-password/. You can change the ending part in the Slug field in the editor sidebar before you publish. Avoid changing it after publishing, because the old address will stop working and anyone who linked to it will hit a missing page.

Saving without publishing

Click Save draft to keep working on a doc without making it public. Draft docs do not appear on your documentation site and are counted separately on the AssistCamp dashboard.

Writing tips for documentation

  • One doc should answer one question. If a doc answers three questions, split it into three docs.
  • Put the answer near the top. Readers arriving from search or from an AI assistant want the answer, not a long introduction.
  • Use numbered steps for anything the reader has to do in order.
  • Write out names in full rather than using “it” or “this”, so each section makes sense on its own.