Glossary
  • 16 May 2022
  • 9 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Glossary

  • Dark
    Light
  • PDF

Article

An article is a written composition in prose on a specific topic in your documentation. In Document360, you can add an article that can define a split piece of information in the documentation.
Read more→


Category

A category is a way to organize group-specific content under a common umbrella.
Read more→


Subcategory

Subcategory in Document360 is used to organize and display groups of similar topic articles, acting as folders that contain groups of related content. Subcategories are just the secondary categories in Documet360. There are three methods to add a subcategory in Document360.
Read more→


Category type

There are three types of categories in Document360

  1. Folder
  2. Index
  3. Page
    Read more→

Folder

A Folder is an entity that holds your articles inside a single package. It is a type of category that does not have its knowledgebase page and is majorly only used for article organization.
Read more→


Index

The index category unlike the folder category has a unique slug that can share the index categories links to the end-users similar to articles.
Read more→


Page

Page is a category type that is used to create an article under the categories in your project. It can be written using the editor (Markdown or WYSIWYG), change page title, slug, same as articles settings this type of category content article.
Read more→


Article status Indicator

The status indicator helps the writer(Contributor) or user(Readers) to know the status of the articles in the knowledge base portal or knowledge base site, without having to check each article individually.
Read more→


New article

A new article is just a blank article that is initially created from the category manager. It is an article that is created and written, but not published. The article is visible only in the portal for team accounts with access.
Read more→


Fork

A fork is an option used to create a new article version. The new version will have the content of the parent version from which it was forked to revise.
Read more→


Draft article

A Draft is an article status that appears in the editor window when a previously published article is forked for revision.
Read more→


Published

An article that has been made public. Readers can view and read it on your knowledge base site.
Read more→


Deprecated

Deprecated is a function used to represent an outdated article in Document360. So, a deprecated article is an obsolete article that offers no value to the reader.
Read more→


Article revision

An article revision is where you can see and manage the forked article versions and the workflow history of the article.
Read more→


Template

Document360 article templates are pre-designed articles that you or any other team account from the project can use while writing articles for your Knowledge base.
Read more→


Editor

An Editor is a tool that a writer uses to draft the content in Document360. Document360 uses two types of editors.
Read more→


Markdown

A markdown editor is an easy lightweight text-to-HTML conversion tool that you can use to format lists, header and importantly you can also use it to add images, videos, and links. Document360 has a powerful markdown editor as one of its two basic editors.
Read more→


WYSIWYG (HTML)

WYSIWYG (What you see is what you get) is one of the two editors used in Document360. It's a content editing tool that allows the writer to see what the result will look like while the interface or document is being created.
Read more→


Contributor

A contributor is typically a team account who has contributed to a project. Document360 automatically tracks the team accounts who have created, forked, saved, written, or published an article and includes them in the public contributor list.
Read more→


Heading Tags

Heading tags in Document360 are used to differentiate headings and subheadings on a knowledge base. H1 is set to default for the article title.

  • H1 tag in the editor is used to add the title for your article. There is no H1 tag in the markdown editor instead you can add it in the WYSIWYG editor.

  • H2 tag in the editor panel is used to add the first sub-title to the main title in the content.

  • H3 tag adds a sub-heading or sub-title and it displays text smaller than H2

  • H4 tag adds a sub-heading or sub-title and it displays text smaller than H3
    Read more→


Text formatting

Text formatting in document 360 is all the formatting options you get in both the editors on Document360 from the basics bold and italics to the more advanced formatting options like LaTeX.
Read more→


Ordered List

An ordered list in general is a list of items in which the order of the items matters. An ordered list is also called a number list.
Read more→


Unordered List

An unordered list typically is a bulleted list of random items.
Read more→


Private notes

Private notes are text elements that, though included within the article text, will not show on public articles except for project team accounts and specific reader groups. These notes can be added in both the Markdown and WYSIWYG editors.
Read more→


Insert LaTeX

Insert LaTeX in document360 is a tool in the editor used to add expressions and equations.
Read more→


Find & Replace

To search a text within your article, and replace it with another text. You can also use this to find the occurrences of the text content in the article. This is particularly handy in long articles
Read more→


Content reuse

Content reuse is a tool used to include frequently used content in form of variables or snippets in an article and the content reuse tool is used by both the editors in Document360.
Read more→


Variable

Variables are text-based content that can be used in many instances and edited on the variables overview page. It also allows you to update the content easily.
Read more→


Snippet

A snippet is a predefined set of content blocks that the content manager or author identifies as reusable content. The content of the Snippet can vary from simple text/phrases to lengthy paragraphs, tables, images, and more.
In the Document360 knowledge base portal, Snippet is stored in a library. These snippets can be inserted into articles at the time of edit with a simple click of a button.
Read more→


Codeblock

Codeblock in document360 is an editor tool that is used to insert code snippets to the article content from the editor.
Read more→


View preview

View preview in the Document360 editor window is used to get the exact knowledgebase view of the article or content before its published.
Read more→


Comments

Comments in Document360 can be enabled for an article with the article setting option from the knowledge base portal.
Read more→


Table of contents

The "Table of contents" is an option you can wish to show or hide using article settings in your knowledge base. Document360 automatically makes a table of contents from any H2, H3, or H4 tag headings included in an article. The table of contents is shown on all articles by default.
Read more→


Feedback

Feedback analytics track likes and dislikes for each article/category page and the feedback left by users in the feedback form.

If a user dislikes or likes an article, the feedback form appears in which the user can leave a comment. The customer can also leave a name and email if they want to be followed up.
Read more→


Discussion

Discussion is an article settings feature in the editor panel of the Document360 portal where you can converse, tag(mention), and collaborate with team members regardless of the roles on your project.
Read more→


SEO

SEO (Search Engine Optimization) is the practice of optimizing your content to generate organic traffic from search engines. In Document360 you can add SEO elements for each article from article settings.
Read more→


Slug

A slug or article slug is the part of the URL that uniquely identifies the article/page, and it's in a format that is easily readable by both users and search engines. This part comes after the "/" in your project root URL.
Read more→


Tags

Tags are keywords related to your article that end users might use while searching your knowledge base. You can enable or disable tags on all article /category pages from the article settings option in your Document360 portal. You can use tag manager from content tools for other tag-related functions.
Read more→


Attachments

Attachments in Document360 can be accessed from Article settings. You could enable or disable the attachments and can also choose the position to display it in the knowledge base.
Read more→


Workflow status

Workflow status is a feature in the Document360 editor which is used to manage and assign workflow statuses to team members. The Workflow status option can be accessed from the top-right, adjacent to the Publish/Edit button from the Documentation editor.
Read more→


Review reminder

Review reminders help team members deliver the most accurate information to customers and internal teams by alerting project members when an article is ready for review. This helps to keep your article up to date.
Read more→


Featured image

A featured image is the pictorial representation of the mood of the content. It appears alongside the content but will not appear in the actual content. In Document360 you can access the featured image from the article settings.
Read more→


Code block

A code block is a feature in the editor panel space for displaying a block of code in an article or page. This feature is available in both the editors of Document360.
Read more→


Find and Replace

Find and replace is a straightforward tool used by Document360 editors to find and replace a specific word or phrase in the content.
Read more→


Private notes

Private notes or Internal notes are notes that, though included within the article text, will not appear on public articles unless you have a team account. They can be added to both the Markdown and WYSIWYG editors.
Read more→


Link status

Links status is a sub-feature under the Analytics section of Document360. This feature is a broken link checker that helps validate and monitor all internal links, external links, and media file links on your knowledge base. It helps you fix bad links to improve SEO and enhance the reader experience.
Read more→


Add template

Add template is a feature in the category management section in Document360 where you can add previously loaded templates as articles.
Read more→


View Markdown

View Markdown is a minor feature in the markdown editor panel of Document360 where you can view an article in the markdown text editor format. You can also view this in the more section of a published article.
Read more→


Copy link

Copy link is a sub-feature that fetches you the article URL and is found in the more section of the editor panel and you can find it only when your article is published.
Read more→


Info

Info is a callout feature that you can find in the editor panel. The info tool will look like a forward-slash in blue color in the editor panel. You can use this to add additional information to your content.
Read more→


Warning

A warning is a callout feature that you can find in the editor panel. The warning tool will look like a forward slash in yellow color in the editor panel. You can use this to add important information to your content.
Read more→


Error

Error is a callout feature that you can find in the editor panel. The error tool will look like a forward slash in red color in the editor panel. You can use this to add essential information to your content.
Read more→


Was this article helpful?