Glossary

A

A record

If you create a website, the IP address will usually be given to you by your DNS registrar when you purchase your domain name. 'A record' can also be pointed to a domain's root. 

For example, If your website is at www.document360.com, then the root of your domain would be document360.com. The root can also be called a "naked domain" and is usually represented by an @ symbol when configuring A record.

AAAA Record

AAAA records are very similar to A records in that they point a domain name to an IP address. The difference is the IP address isn't a typical IPv4 address like: 168.201.255.18. 

Instead, AAAA records point to IPv6 addresses like 2001:0db8:85a3:8554:0000:6b3d:0370:6458.

Access permission

The permissions a team account has in the knowledge base portal features and its content. Only the authorized features and content would be visible to the team account. 

View your access scope using Profile > View access permissions1_Screenshot-Profile_menu_accessing_view_your_permissions

Add template
Add template is a feature in the category management section in Document360 where you can add previously loaded templates as articles.
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.
Article revision
An article revision is where you can see and manage the forked article versions and the workflow history of the article.
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.
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.

B

Block editor

A lightweight and powerful Document360 editor with rich text editing capabilities and supports Markdown syntax. It provides a more visual and intuitive experience than the Markdown editor while still being more flexible than the WYSIWYG editor.

C

CA

Certificate Authority is a trusted third-party entity that issues digital SSL certificates & manages the identification and public keys for encrypting information.

For example, Let's Encrypt, GeoTrust, Symantec, Comodo, and more.

CAA

A Certification Authority Authorization (CAA) record allows domain owners to declare which certificate authorities can issue a certificate for a domain. They also indicate notification rules if someone requests a certificate from an unauthorized certificate authority. 

For example, If no CAA record is present, any CA is allowed to issue a certificate for the domain. Only the CAs listed in the record(s) can issue certificates for that hostname if a CAA record is current.

Category
A category is a way to organize group-specific content under a common umbrella.
Category manager

The left navigation pane that appears in the Documentation editor. This section allows you to manage and perform article and category relation functions.
3_Screenshot-New_category_documentation


Category type

There are three types of categories in Document360

  1. Folder
  2. Index
  3. Page
CNAME

A CNAME or Canonical Name record is a type of DNS record that maps an alias name to a valid or canonical domain name. 

A CNAME record is used to map a subdomain to the domain hosting its content.

For example, a CNAME record can map the web address www.document360.com to the actual website for the domain document360.com

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.
Codeblock
Codeblock in document360 is an editor tool that is used to insert code snippets to the article content from the editor.
Comments
Comments in Document360 can be enabled for an article with the article setting option from the knowledge base portal.
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.
Content role

The Content role defines the permission for knowledge base content a team account can perform in the knowledge base portal.

8_Screenshot-Content_role_view permission

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.
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.

D

Dashboard

The space where you can view and access all the Document360 projects you own and is associated with, either as a team account or as a reader.   

1_Screenshot-Portal_dashboard

Dependencies
Dependencies are a state of being dependent on something( File dependencies are a common factor). It shows the list of articles where a file is present.
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.
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.
DNS Name server

A DNS name server is a server that stores the DNS records, such as address (A, AAAA) records, name server (NS) records, and mail exchanger (MX) records for a domain name (see also List of DNS record types) and responds with answers to queries against its database.

Download
Download(ing) is a process of receiving data or files from your Document360 drive to your local system over the network. You can download either files or folders to your system.
Draft article
A Draft is an article status that appears in the editor window when a previously published article is forked for revision.
Drive
Drive in Document360 is a centralized cloud-based storage repository that lets customers store and manage all files. If you have already used any of the other tools such as Google Drive or OneDrive, getting used to all functions in Document360 Drive would be easy.

E

Editor
An Editor is a tool that a writer uses to draft the content in Document360. Document360 uses two types of editors.
Editor folder
An Editor folder is the default folder in the Drive, where all the image files uploaded directly from the documentation editor using the Insert image option are saved. Previously, the Documentation system folder was set as the default editor folder and could not be changed.
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.

F

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.
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.

Feedback manager

The Feedback manager keeps track of all your feedback on articles and categories in your Knowledge base and Knowledge base assistant. It helps you to assign and track them effectively. 

2_Screenshot-Feedback_overview


File

A file is a small unit in a system where the data is summarized. File types supported by Document360 are

  • Image Files
  • Microsoft PowerPoint PPT
  • Microsoft Word Docs
  • PDF
  • Zip


File picker
A file picker is an option that you find inside the insert image option on the editor. The file picker represents the drive storage in Document360. The images input through the file picker will be the right size regardless of the type of file a user uploads either from the application (drive) or their local devices.
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.
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.
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.

G

Grid view
The grid view is a tabled view of a data source in your drive.

H

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 and H4 tag adds a sub-heading or sub-title and it displays text smaller than H2

Home page

The Home page is the first page an end-user will see when they visit your knowledge base site.

1_Screenshot-Document360_landing_page


Home page header

The header section appears at the top of your home page and is the only section within the Home Page Builder that cannot be deleted or moved. It includes a title for your knowledge base, a tagline, customizable links, and a powerful search.

I

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.
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.
Insert LaTeX
Insert LaTeX in document360 is a tool in the editor used to add expressions and equations.
Integration

Document360 facilitates easy integration of third-party apps and services into your knowledge base.

J

JSON

JavaScript Object Notation (JSON) is a lightweight data-interchange format that machines can parse and generate easily. It is a text-based format that represents data as key-value pairs and arrays. It is commonly used for data exchange between web applications and APIs.

K

Knowledge base

A Knowledge base (KB) is a self-serve online library of information about a product, service, department, or topic.

Knowledge base assistant

An in-app assistant that helps your users find the answers they need without leaving your site or application.

Knowledge base portal

Knowledge base portal is where project members would create category, articles, templates, manage Files, team accounts, and readers, and set up Knowledge base site branding, domain, security, and so on.

Knowledge base site

The Knowledge base site is the website end-users will access to read articles and find helpful answers. 

Knowledge management

Knowledge management is the process of organizing, creating, using, and sharing collective knowledge within an organization.

L

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.
List view
List view is used to group several data in a vertically scrollable list. List view is used for a quick visit.
LTV

Life time value

M

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.

N

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.

O

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.

P

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.
Portal role

The Portal role defines the permission for activities a team account can perform in the Knowledge base portal.

11_Screenshot_Portal role


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.
Published
An article that has been made public. Readers can view and read it on your knowledge base site.

R

Reader

Readers are different from team accounts in that they are not contributors to a knowledge base. They can only view the content of a knowledge base site.

Recent folder
The recent folder is a default folder in the drive on your Document360. It is a dynamic folder populated with files and folders based on the latest addition or upload (The last 2 days).
Recycle bin

When managing large quantity of files/folders, mishaps like accidental deletions are bound to happen.

To address it, 'Document360 drive' comes with the recycle bin. The name and the function are self-explanatory. When a user removes or deletes a file/folder, it will be moved to the recycle bin folder.

Replace
Replace is used to change one file with another. You can only replace files if the old and new file format is the same (ex. .pdf file with .pdf file and not .pdf file with .docx file). In the case of image files, the image dimensions can vary.
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.

S

SAML 2.0

One of the SSO standards

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.

server variables

Server variables are placeholders for values that can be used to configure or customize the behavior of an API server. They are defined in the API specification and can be used to define different environments or contexts in which the API is used.

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.
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.

specification file

An API specification file is a document that outlines the technical details and requirements of an API. It typically describes how the API works, what resources it exposes, and what methods and endpoints are available to developers.

SSL Certificate

An SSL (Secure Sockets Layer) certificate is a digital certificate that authenticates the identity of a website and encrypts information sent to the server using SSL technology.

An SSL certificate contains the following information:

  • The certificate holder's name
  • The certificate's serial number and expiration date
  • A copy of the certificate holder's public key
  • The digital signature of the certificate-issuing authority (CA)
Starred folder
A starred folder is a default folder found in the drive on your Document360. If you use a particular file or a folder often in your documentation, you can make it easier to retrieve and view in the drive with the Add to Starred feature.
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.
Subfolder
Subfolder in Document360 drive is just a secondary folder you create inside the primary folder.
System folder

Every project comes with a default 'Images' folder in Drive, which includes three sub-folders: Documentation, Settings, and Home page builder.

Images, Settings, Home Page Builder, and Documentation are system folders. You can identify these folders by the shield symbol on the folder icon.

T

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.
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.
Team account

A Team account is an end-user who must log in with their credentials to access the Knowledge base portal and manage the version(s), language(s), categories, and articles.

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.
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.
TTL

Time-To-Live can describe the time that a DNS record is returned from the cache. TTL is a numerical value set in a DNS record in this context. It defines the number of seconds a cache server can provide its cached value for the record.

For example 600 (which indicates seconds, so the TTL here is 10 minutes

TXT

TXT records are a type of Domain Name System (DNS) record containing text information for sources outside your domain. You add these records to your domain settings. You can use TXT records for various purposes. Document360 uses them to verify domain ownership and to ensure email security.

U

Unordered List
An unordered list typically is a bulleted list of random items.
Upload
Upload is simply the opposite of the download. While uploading, you are sending data from your device to the Document360 drive through the internet.
URL

Uniform Resource Locator (URL) is a standardized way of specifying the address of a resource on the Internet. It is essentially a web address that specifies the protocol (HTTP, HTTPS, FTP, etc.), the domain name or IP address of the server hosting the resource, and the path to the resource.

V

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.
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.
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.

W

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.
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.
WYSIWYG

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.

Y

YAML

YAML Ain't Markup Language (YAML) is a human-readable data serialization format for configuration files and data exchange between applications. It uses a key-value pair structure to represent data, but it uses whitespace indentation rather than brackets to define the data hierarchy.

ESC

Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses