How to Create Documentation in Document360

Document360 is a purpose-built knowledge base platform, and that specialization shows. Unlike help desk tools that bolt on a knowledge base as a secondary feature, Document360 was designed from the ground up for documentation. It offers features like category-level versioning, article-level analytics, Markdown and WYSIWYG editors, and role-based authoring workflows that more generalized platforms simply do not provide.

But powerful features do not guarantee a useful knowledge base. The platform gives you the tools. You still need the strategy.

Key Insight: Document360 reports that knowledge bases with structured visual content achieve 40% higher engagement rates than text-only knowledge bases. Readers stay longer, follow more steps successfully, and rate articles as more helpful.

This guide covers the complete process of creating documentation in Document360 -- from workspace configuration to article writing, visual content, version management, and ongoing optimization.

Setting Up Your Document360 Workspace

Document360 organizes everything around projects. Each project is a self-contained knowledge base with its own categories, articles, settings, and team members. You can run multiple projects for different products, audiences, or use cases.

After signing in, create your first project from the Document360 dashboard. You will be prompted to choose between a knowledge base project and an API documentation project. For customer-facing help content, select knowledge base.

Initial Configuration

Project name and URL -- Choose a descriptive project name and configure your knowledge base URL. Document360 provides a default subdomain (yourproject.document360.io), but you should set up a custom domain (docs.yourcompany.com) under Settings > Custom Domain for a professional appearance
Home page design -- Document360 offers a customizable homepage for your knowledge base. Configure the header, search bar placement, category grid layout, and featured articles. A clean homepage with a prominent search bar and 5-8 visible categories is the standard that works
Branding -- Set your logo, favicon, brand colors, and typography under Settings > Appearance. Document360 provides enough customization to make your knowledge base feel like a native part of your product ecosystem
Team and roles -- Invite team members and assign roles. Document360 has granular roles including Owner, Admin, Editor, Draft Writer, and Viewer. Use these to control who can publish articles versus who can only draft them
Access control -- Choose between a public knowledge base (visible to everyone, indexed by search engines) and a private one (requires authentication). You can also mix access levels, making some categories public and others private

Pro Tip: Start with your knowledge base in private mode while you build initial content. Switch to public once you have at least 20-30 articles covering your most common customer questions. Launching a sparse knowledge base can hurt more than it helps.

Organizing Categories and Subcategories

Document360 supports a deep category hierarchy -- up to six levels of nesting. But just because you can create six levels does not mean you should. Most effective knowledge bases use two to three levels.

Plan your category tree on paper or in a spreadsheet before creating anything in Document360. This prevents the awkward reorganization that happens when you realize your initial structure does not scale.

Category Structure Principles

Top-level categories (Level 1) -- These are the broad themes visible on your homepage. Keep them between 5 and 8. Examples: Getting Started, Account Management, Features, Integrations, Troubleshooting, API Reference
Subcategories (Level 2) -- These break down broad themes into specific areas. Under "Features," you might have subcategories for "Reporting," "Automation," "User Management," and "Data Import"
Article grouping (Level 3) -- Only use a third level when a subcategory has enough articles (10 or more) that further grouping genuinely helps navigation. Do not create a third level with just one or two articles

Category-Level Settings

Document360 lets you configure settings at the category level:

Visibility -- Some categories can be public while others are restricted to authenticated users
Category icons -- Add icons to make the homepage visually distinctive and help customers quickly identify the right section
Default article ordering -- Choose between manual ordering, alphabetical, or by most recently updated. Manual ordering gives you the most control over what customers see first

Common Mistake: Creating a category for every micro-topic. If a category has fewer than three articles, it probably should be a subcategory or its articles should be merged into a related category. Sparse categories make the knowledge base feel incomplete.

Writing Articles in Document360

Document360 offers two editors: a Markdown editor for teams that prefer writing in Markdown, and a WYSIWYG editor for those who prefer a visual writing experience. Both produce the same output. Choose based on your team's comfort level.

The WYSIWYG editor is the better starting point for most support teams. It provides a familiar writing experience with toolbar buttons for formatting, image insertion, table creation, and callout boxes.

Article Structure Template

Every article should follow a consistent structure:

Title -- Task-oriented or question-based. "How to configure SSO with Okta" or "Why is my data import failing"
Description/summary -- Document360 includes a meta description field. Write a concise summary that appears in search results
Prerequisites -- State any requirements upfront: plan level, role permissions, prior configuration steps
Step-by-step body -- Numbered instructions with one action per step. Begin each step with an action verb
Annotated screenshots -- Insert a screenshot after each key step showing the relevant UI. Use annotations to highlight the exact button, field, or area the customer should focus on
Expected outcome -- Describe what the customer should see when the task is complete
Notes and warnings -- Use Document360's built-in callout blocks for tips, warnings, and important notes
Related articles -- Link to connected content using Document360's internal linking feature

Markdown vs. WYSIWYG

If your team uses the Markdown editor, Document360 supports standard Markdown syntax plus extensions for callouts, tabs, and embedded content. The Markdown editor also integrates with GitHub for teams that want to manage documentation as code.

Key Insight: Articles that follow a consistent template across the entire knowledge base see 28% higher helpfulness ratings than articles with inconsistent formatting. Predictable structure lets customers focus on the content rather than figuring out the format.

Adding Visual Content to Articles

Document360's editors support inline images, GIFs, and embedded videos. The platform also includes a built-in image manager where you can store and organize all your visual assets.

Visual content is not supplementary. It is essential. Every step in a how-to article that involves a UI interaction should have an accompanying screenshot.

Screenshot Best Practices

Capture the relevant context -- Show enough of the surrounding interface so the customer can orient themselves. If the action is in a settings panel, include the sidebar or breadcrumb navigation
Annotate with intention -- Add numbered callouts that correspond to your step numbers. Use arrows to direct attention. Highlight clickable elements with colored borders. ScreenGuide is built for this exact workflow -- capture, annotate, and export screenshots with consistent styling that integrates cleanly into Document360's editor
Optimize file size -- Large images slow page load times. Compress screenshots before uploading while maintaining readability. Document360's image manager does not automatically compress images, so handle this before upload
Use the image manager -- Upload screenshots to Document360's centralized image manager rather than inserting them ad-hoc. This makes it easier to find and replace images when the UI changes
Alt text -- Add descriptive alt text to every image for accessibility and SEO

Pro Tip: Maintain a screenshot naming convention that includes the feature area and step number. For example, "sso-config-step3-provider-selection.png" tells you exactly what the image shows without opening it. This becomes invaluable when you need to update screenshots after a UI change.

Embedded Videos and GIFs

For multi-step workflows where sequence matters, short GIF recordings can be more effective than a series of screenshots. Document360 supports GIF embedding directly in articles. Keep GIFs focused on a single interaction and under 10 seconds.

For longer walkthroughs, embed videos from YouTube, Vimeo, or Loom. Always provide a text-and-screenshot version alongside the video for customers who prefer reading or cannot watch video.

Leveraging Document360's Version Control

One of Document360's standout features is version control. You can create new versions of your entire knowledge base or individual categories, which is essential for products that maintain multiple active versions.

If your product has different versions in production simultaneously, version control prevents the nightmare of maintaining separate, duplicated knowledge bases.

How Versioning Works

Project versions -- Create a new version when you release a major product update. The previous version remains accessible for customers still on the older release
Category versions -- You can version individual categories independently, useful when only part of your product receives a major update
Default version -- Set the most current version as the default. Customers can switch versions from the knowledge base interface if they need documentation for an older release
Version comparison -- Document360 lets you compare articles across versions to see what changed, which helps during documentation updates

Common Mistake: Ignoring version control and maintaining a single version that reflects only the latest product release. If any of your customers are on older versions, they need accurate documentation for their version, not yours.

When to Use Versioning

Versioning is most valuable for:

Software products with multiple active releases -- Customers on version 3.x need different instructions than customers on version 4.x
API documentation -- Different API versions often have different endpoints, parameters, and response formats
Regulated industries -- Where documentation must match the exact version of the product being audited

For products where all customers are always on the latest version (like most SaaS tools with automatic updates), versioning may be unnecessary. Do not add complexity that your use case does not require.

Search and Navigation Optimization

Document360 includes an AI-powered search engine that indexes article content, titles, descriptions, and tags. It supports natural language queries and returns results with highlighted snippets.

Search is the primary way customers interact with your knowledge base. Optimizing for search is optimizing for self-service success.

Search Optimization Tactics

Customer language in titles -- Use the phrases your customers actually type. "How to cancel my account" will match customer queries better than "Account Deactivation Procedure"
Tags and keywords -- Document360 lets you add tags to articles. Include synonyms, common misspellings, and abbreviations. An article about "single sign-on" should be tagged with "SSO," "SAML," "login," and "authentication"
Descriptive headings -- Subheadings carry search weight. Use specific headings like "How to add a team member" rather than generic ones like "Team Settings"
Rich snippets -- Document360's search displays article snippets. Write clear first paragraphs that communicate the article's topic so snippets are informative

AI-Powered Features

Document360 includes AI-powered features like Eddy, an AI assistant that can suggest answers to customer queries based on your knowledge base content. Configure this under Settings > AI Features. Ensure your articles are comprehensive and well-structured so the AI surfaces accurate, relevant responses.

Key Insight: Document360's analytics show that knowledge bases with articles tagged with three or more relevant keywords see 45% better search match rates than those with no tags. Tags are the cheapest way to improve discoverability.

SEO for Your Public Knowledge Base

If your Document360 knowledge base is public, search engine optimization determines how effectively your articles capture organic traffic from Google.

Document360 generates clean URLs and provides meta description fields for every article. Use these intentionally.

SEO Essentials

Custom meta descriptions -- Write 150-160 character descriptions for each article that include the primary keyword and a clear value proposition
URL slugs -- Document360 auto-generates slugs from titles. Review and shorten them if needed. "how-to-export-data-csv" is better than "how-to-export-your-data-as-a-csv-file-from-the-reports-section"
Sitemap -- Document360 auto-generates a sitemap. Submit it to Google Search Console to ensure all articles are indexed
Internal linking -- Link related articles to each other. This helps search engines crawl your knowledge base effectively and encourages customers to explore related content
Image optimization -- Compress images, use descriptive file names, and always include alt text

Pro Tip: Use Google Search Console to monitor which queries drive traffic to your knowledge base. Queries with high impressions but low click-through rates need better meta descriptions or titles. Queries with no matching content are direct signals for new articles to create.

Analytics and Continuous Improvement

Document360 provides detailed analytics at the article, category, and project level. These metrics tell you what is working, what is not, and where to focus your efforts.

Key Metrics

Article views -- Track views over time to identify trending topics and seasonal patterns
Search analytics -- Monitor the most common search queries and which ones return no results. Zero-result queries are your content gap roadmap
Article feedback -- Document360 includes thumbs-up/thumbs-down feedback on articles. Track the aggregate helpfulness score and prioritize rewriting poorly rated content
Time on page -- Very short times suggest the article did not answer the question. Very long times may indicate the article is confusing
Broken link reports -- Document360 detects broken internal links. Fix these promptly to prevent dead-end navigation

Maintenance Cadence

With every product release -- Update affected articles and screenshots immediately
Monthly -- Review analytics, address negative feedback, fill content gaps from search data and support ticket analysis
Quarterly -- Audit the full category structure, archive deprecated content, and review the overall knowledge base health

Common Mistake: Building a knowledge base and never revisiting the analytics. Document360 gives you exceptional data. Use it. Schedule a recurring monthly review and assign ownership for acting on the insights.

TL;DR

Set up your Document360 workspace with a custom domain, branded homepage, and proper team roles before creating content

Organize content in a 2-3 level category hierarchy with 5-8 top-level categories based on customer needs

Write consistently structured articles with step-by-step instructions, annotated screenshots, and callout blocks for tips and warnings

Use Document360's version control for products with multiple active releases to keep documentation accurate for every customer

Optimize for search with customer-language titles, descriptive tags, and clear first paragraphs that appear in search snippets

Review Document360's analytics monthly to identify content gaps, rewrite underperformers, and track self-service effectiveness

Ready to create better documentation?

ScreenGuide turns screenshots into step-by-step guides with AI. Try it free — no account required.

Try ScreenGuide Free