Shortcut Docs allows for free form documentation, ideation, and collaboration in an easy-to-use document editor.
You can use Docs to house any internal documentation that you would like to share or reference anywhere in Shortcut. Here are a few ways our team uses Docs
-
Creating a simple, clean list of action items
-
Housing release notes
-
Sharing meeting minutes
-
Drafting marketing and blog posts
-
Planning Team goals in a living, collaborative document
Check out the Getting Started with Docs video for a quick overview.
Docs Menu
The Docs Menu found on the left-hand side of the page allows you to navigate between your personal collection of docs and docs publicly available throughout the Workspace.
- Recent
- Recently viewed Docs.
- My Docs
- Docs that you've created.
- All Docs
- Docs that are publicly available in the Workspace.
- Following
- Docs that you've added as "Following".
- New comments in these Docs generate email notifications.
- Templates
- A set of Doc Templates that can be easily accessed and edited for common use cases.
- Collections
- A labeled group that Docs can be added to (similar to how an Epic houses Stories).
Doc Permissions
What are Doc Permissions?
Do you have sensitive information that you want to restrict access to? Well, now you can in Docs! Doc Owners can choose to assign Doc Access by selecting the dropdown menu at the top-right of the page. Choose between Workspace-wide, Shared (with specific teammates), or Private (only visible to you).
Suggestion Mode
Suggestion Mode is only available for Team, Business, and Enterprise plans.
Any doc editor can place a document in "Suggesting" mode by clicking the dropdown in the top right corner. By default, a document is opened in "Editing" mode.
Suggestion mode allows other doc collaborators to see what changes are proposed - additions, deletions, or formatting changes. Additions are shown in green, deletions shown in red, and formatting changes are shown in blue. Suggestions can be accepted or rejected in the comments section.
The Blocks Toolbar
Check out the versatility of blocks! You can add customized lists, quotes, tables, multimedia, and code blocks. Simply select the icon (Edit Block) to get started!
- Heading Styles
- Make your text more visible by adding heading styles (1-3).
- Lists
- Choose between bulleted, numbered, or to-do lists.
-
Tip
Threaded lists can be created by selecting Enter to create a new list line and then Tab to create a sublist.
- Block Quote
- Highlight text as a quote to make it more visible.
- Horizontal Line
- Add a horizontal line in the Doc to segment or section text.
- Code Block
- Add a code block by choosing between different markup/programming languages.
- Table
- Add a table with customized rows and columns.
- Image/Video
- Add an image from your device or embed a video by entering its URL. Note: only the following domain are supported for video: Youtube; Vimeo; Dailymotion; Spotify.
Looking to format your text, create a Story, or add a comment? Simply start by highlighting some text.
- Text Style
- You can add bold, italic, and strikethrough formatting to your text.
- Highlighting
- Add highlighting to your text using one of four colors.
- Create
- Stories, Epics, Iterations, and Objectives can be planned, created, and assigned directly from a Doc. No need to hop back and forth. Note: the highlighted text will become the respective entity's title.
- Link
- Add a URL to the highlighted text to format it as a hyperlink.
- Code
- Wrap the text in code formatting.
- Comment
- Add a comment to the Doc referencing the highlighted text.
-
Mention a teammate in a comment by entering "@" and selecting their name.
Doc Actions
Look for the symbol. This menu is accessible from within the Doc in the upper left.
Follow
Allows a user to Follow a Doc they would like to quickly find and reference. If you Follow a Doc, you would also receive a notification if a comment was added, even if you’re not @ mentioned
Archive
Allows a user to "Archive" a Doc that is no longer needed but still wants it to be kept for reference. Archived documents can't be edited and any comments are hidden. To edit this document you can unarchive it.
Delete
Allows a user to delete a Doc that is no longer needed. Deleting a Doc will remove it from your Workspace and all associated Collections will be removed.
A deleted Doc cannot be recovered.
Doc Relationships
There are two types of Relationships for Docs:
| Mentioned | Related |
|---|---|
|
|
Mentioning and Relating Guide
To Add Mentions in a Doc for Stories, Epics, Iterations, Objectives, and other Docs
To quickly insert a Shortcut link for a Story, Epic, Iteration, Objective, or Doc, you can utilize the keyboard shortcut "/" - which will populate the search bar right on the Doc. Once added, the mentioned Story, Epic, Iteration, Objective, or Doc will be reflected in the Doc Relationships sidebar.
→ Another method is to copy and paste a direct URL link into a Doc. The mentioned Story, Epic, Doc, Objective, Iteration, Label, or Project is shown as a badge on the Doc, as follows:
The Roadmap, Team detail, and Reports pages cannot be mentioned at this time.
→ For a quick view of the information within each respective Shortcut entity, such as progress and other important details, simply hover over the linked Story, Epic, Iteration, Objective, or Doc.
To Add Relationships in a Doc for Stories, Epics, Iterations, Objectives, and other Docs
→ Search for the respective entity in the Search bar in the Relationships sidebar.
To link a Doc from a Story:
→ Use the Relationships Option, Docs Tab, and search for the Doc.
To link a Doc from an Epic, Iteration, Label, Objective, or Project:
→ Use the "Link Doc to [Epic, Iteration, Label, Objective]" option. You may also create a Doc from here by clicking Create Doc for []. This newly created Doc will automatically be linked.
Doc Mention and Relationship Managment
To Remove Mentions in a Doc for Stories, Epics, Iterations, Objectives, and other Docs
→ Use the "Link Doc to [Epic, Iteration, Label, Objective]" option. You may also create a Doc from here by clicking Create Doc for []. This newly created Doc will automatically be linked.
Updated