Cubetorials

A brief tour of ClickUp Docs

October 3, 2023
5 min read
Diego Torres
Founder

A true all-in-one solution

If you use a work management tool to manage your projects and tasks, you understand the value of organizing your work digitally in one place. Most companies in this space aim to become an all-in-one solution for teams managing different aspects of work. Yet, there is no universal definition for the term all-in-one as it relates to work management tools.

Some companies use this term to describe their product's ability to accommodate any project, process, or workflow within the tool's data model. Others use it to describe the plethora of features available to users, like forms, multi-homing, or custom dashboards that enable teams to manage any type of project at scale.

But organizing work and collaborating with your team requires documentation. It would be fitting for a tool that labels itself an "all-in-one" solution to include a way for users to manage documentation within the context of the work they're tracking in the system. Whether that includes writing a project plan, a Standard Operating Procedure (SOP), or capturing weekly meeting notes, most work management tools don't have built-in word processors to create documents, forcing you out of your environment to use another solution.

ClickUp is changing the game

While most work management tools focus on task management, status updates, and analytics as core elements of their product, the team at ClickUp has added composing and managing documents to their arsenal.

ClickUp Docs enhances the meaning of the term "all-in-one" by incorporating documentation into its holistic framework.

With Docs, you can:

  1. Create documents that contain multiple pages and sub-pages
  2. Use rich text to format pages with headings, body text, quotes, checklists, and more
  3. Power up your docs with slash commands to easily add task lists, links, media, and more directly to your page
  4. Collaborate simultaneously with others and write comments using rich-text and slash commands
  5. Share docs with others on the web, or export them to an HTML or PDF file
  6. House your docs within the context of your work, such as within a Space, List, or a specific task.

Let's take a closer look at each of these features to determine how they can enhance your productivity.

Create documents with multiple pages and subpages

Docs can be organized into pages and sub-pages, allowing your team the flexibility to define the topics of your documentation as you see fit. You can add as many documents and pages as you want, and each page can contain up to four sub-pages.

How this benefits you:

If you're responsible for authoring content or are on the receiving end, sub-pages help keep content organized within the context of a topic. This level of organization makes it easier to break down complex concepts or processes across pages into digestible chunks, while still keeping the content searchable within one overall document. Sub-pages also add an interactive layer to the reading experience since you have to click on a sub-page to view the content within it.

Organizing pages hierarchically is highly useful for teams who need a document management solution rather than just a simple composition tool. For instance, teams using ClickUp Docs as a knowledge base solution, or as a way to write SOPs and help articles for their departments require documentation that enables anyone viewing it to extract important information efficiently, without having to scroll through irrelevant content. Knowledge retention is often expedited when it is delivered to the recipient in segments.


Use rich text to format your page content

Format text on your page using rich text functions like headings, quotes, checklists, highlights, code blocks, and a whole lot more.

Here's a list of the some of the rich text features available to you with Docs:

  • Choose between font styles like Headings 1-3, normal text for paragraphs, and block-quotes
  • Bold, italicize, underline, strike-through, align, and indent text on your page
  • Add bulleted and numbered lists, and checklists
  • Add a quote, embed code, or create hyperlinks anywhere on your page
  • Add code snippets to your page and copy markdown
  • Change the font and background color of text

Power up your docs with Slash commands

Press the forward slash on your keyboard and you'll unlock a gold mine of valuable elements to include directly to your page. The elements available to you are categorized into four sections below.

  • Popular: Includes a check list, horizontal line divider, bulleted list, table, code block, button, and a table of contents (based on your headings).
  • Editing: Includes Headings 1-3, normal text, inline code, a block-quote, a colored banner, hyperlink, and toggle list. Use basic text features like bolden, italicize, and strike-through font, and change the background color of text.
  • Embed: Add links or integrate third-party tools directly to your page. Add one of your task lists, embed tools like CloudApp, a video from YouTube or Vimeo, a Figma design, Loom recording, a GIF, or editable content from Google Drive, Docs, Slides, or Sheets. And that's just to name a few.
  • Task Actions: Apply a template, create a new page or sub-page, add an attachment, or paste markdown directly to your page.

Collaborate with others in real-time

Your team can edit documents simultaneously with visual markers to know where others are editing in real-time. While this feature is common among traditional tools like Google Docs or Microsoft Word Online, ClickUp lets you create and manage tasks without leaving a document.

For instance, you can leave a comment for a collaborator to review a particular paragraph on your page. The Comments panel is treated as a request system for any collaborators to review and take action on. New comments are considered "Open", and can be converted to a task, assigned a teammate, and housed within an existing project space until it is marked resolved. To further enhance the readability of your comments, you have access to the same rich text features and slash commands writing a comment as you do writing on a page.

Give your Docs a home

Once your Doc is ready to go, you can house it within a Space, Folder, List and even a specific task to keep your content within the context of your team's work. If you're not sure where your Doc should go, your Doc can be accessed from the All Docs or Recent Docs views on your left sidebar. Docs can be moved to a new location at any time and viewing permissions can be set on a Business plan for exclusive access when needed.

Share and/or export your Doc

You can share your entire document or a single page with others via the web using a public or internal link. When sharing a link, you can configure settings like scheduling an expiration date, adjusting embed frame dimensions, and toggling search engine visibility. You can also export to a PDF, HTML, or Markdown file and share an attachment using your method of choice.


Docs live inside of your work

ClickUp Docs has been an incredible asset for teams looking to house documentation within the context of their projects and tasks without having to leave the platform. It's an effective way to manage your team's access to documentation with enough customization and formatting features to keep documentation interactive and engaging for both collaborators and viewers.