What Is DocAssemble?
DocAssemble is a new tool for Central Support Knowledge that allows writers to assemble the needed contents for a knowledge base article logically.
DocAssemble is a free-open source expert system for guided records and document assembly. It provides a web site that conducts interviews with users. Based on the information gathered, the interviews can present users with documents in a PDF or DOCX format, which users can download or e-mail.
DocAssemble relies on an implementation of Python and syntax written in YAML and Markdown.
Why Should I Use DocAssemble?
DocAssemble simplifies the writing workflow and hassles over where or how to section your content. Follow the instructions, and DocAssemble will build out the article objective for you.
After each section, you will receive an overview of your composition. This approach will allow you to stay on track with what you want to write and present it in the best manner possible to communicate with your target audience.
How Do I Use DocAssemble?
You can follow the following links, depending on the type of article you would like to submit:
- Solution Article Template
- Training Article Template
- Solution Article Template - Advanced (limited wizard instructions)
The interface is quite user-friendly and very straightforward to use. Follow the steps provided in each section as you fill out your article. DocAssemble will take care of logically assembling the document as you go through.
Where Do I Save?
DocAssemble will automatically save your interview progress up to the last step you completed. When you log back in, you will be automatically routed to the latest unfinished interview.
You can also click your email at the top-right corner and then on 'My Interviews' to see the list of interviews you have started on DocAssemble.
Can I Format Text?
DocAssemble formatting is based on Markdown, which is a lightweight markup language that you can use to add formatting elements to plaintext text documents.
Please visit the Markdown Guide Cheat Sheet to obtain a quick reference to the Markdown syntax.
Does It Have Grammar or Spell-Checking Functionalities?
DocAssemble does not natively support grammar or spell-checking functionalities (yet); however, we recommend the usage of DocAssemble with the Grammarly Browser Extension.
Grammarly is a free online grammar checker and proofreading tool. Grammarly will mark mistakes with red lines (as seen below). Hover your mouse over an underlined word to see correction suggestions.
Please visit Install the Grammarly Browser Extension to learn more about installing this extension.
What Should I Do With My Finished Product?
Once you have your assembled document, submit a request to the Knowledge Architects team, attaching the PDF or DOCX file, to publish the article in the product knowledge base.
Please submit a request through the CS Knowledge Zendesk portal.
I Found A Bug! Should I Report It?
Yes! DocAssemble is a tool undergoing constant evolution.
As more users run through it, we welcome the feedback and reports for improvements or defects found. Please use this form to provide feedback.
Visit our release notes to check our latest fixes and enhancements.