Documents is the workspace for reviewing and organizing written guides and platform documentation in your Organization. Documentation managers, technical writers, support agents, and operations managers can use it to find documents by view, search for relevant content, and begin organizing documentation with categories.
Use Documents when you need to review the current documentation collection, focus on a particular document state, or locate a document by text.
Note: The available views help you narrow the displayed document list. They do not, based on the available controls, provide a documented action for changing a document from one view to another.
Settings
Before organizing documents, establish the categories that your team will use consistently. Categories support a more structured documentation workspace by providing a way to group related documentation.
From the main navigation, select Documents.
Documents
Add CategoryPublishedRecently Updated
To begin creating an organizing category, select Add Category.
Documents
Add CategoryPublishedRecently Updated
The available screen confirms that Add Category begins the category-addition flow. Complete only the options shown in the category flow after it opens.
Tip: Agree on category names within your team before adding them. Consistent names make it easier for writers and support teams to organize and review documentation.
Workflow
Use the following decision points to review documents and locate the content you need.
Choose the scope of documents to review
Open Documents from the main navigation.
Documents
Add Category
Decide whether you need the complete document collection or a focused view:
Select All to display all available documents.
Select Draft to display documents in the Draft view.
Select Published to display documents in the Published view.
Select Archived to display documents in the Archived view.
Select Recently Updated to display recently updated documents.
Review the documents displayed in the selected view. If the view does not contain the document you need, choose a different view or search by text.
Search when the document is not visible in the current view
Select the Search... field.
Enter text that identifies the document you need, such as a guide title, feature name, product term, or support topic.
Review the matching available documents. If the results are too broad, refine the entered text. If no suitable result appears, switch to another document view and search again.
Tip: Start with a distinctive term rather than a broad term. For example, search for a feature or workflow name instead of a generic word such as “guide.”
Organize documentation when a new category is required
While in Documents, determine whether the existing organization is sufficient for the documentation you are reviewing.
If a new grouping is needed, select Add Category to begin the category-addition flow.
Continue with the category options presented by the platform. Return to the document views to review the organized documentation collection.
Warning: Do not assume that selecting a view changes a document’s publication or archive status. The available controls show views for Draft, Published, and Archived documents, but do not show a status-change action.
All
The All view displays all available documents. Use this view when you do not want to limit the list to a particular document state or recent-update scope. From here, you can use Search... to narrow the available documents by entered text.
No action is provided on this screen to move a document into or out of the All view. It is a broad review view of the available documentation collection.
Manual
The Manual view is available as a document view in the Documents workspace. Select it when you need to narrow the displayed documents using this view label, then review the documents shown or use Search... to refine the list further.
The available controls do not identify an action that moves documents into or out of the Manual view.
Generated
The Generated view is available as a document view in the Documents workspace. Select it to narrow the document list using the Generated view, then use the displayed results for review or search within the available documents.
The available controls do not identify an action that moves documents into or out of the Generated view.
Draft
The Draft view displays documents in the Draft view. Use it when reviewing documentation that is currently presented as draft content, such as content requiring review before it is treated as published documentation.
The available controls do not show an action that moves a document from Draft to another view. To locate a specific draft, use Search... after selecting Draft.
Published
The Published view displays documents in the Published view. Use it when you need to review documentation presented as published content, including information that may be used by documentation, support, or operations teams.
The available controls do not show an action that moves a document into or out of Published. Use Search... to find a specific published document by text.
Archived
The Archived view displays documents in the Archived view. Use it when reviewing documentation that is no longer shown in the active Draft or Published views.
The available controls do not show an action that archives or restores a document. This view is for locating and reviewing the documents displayed as archived.
Recently Updated
The Recently Updated view displays recently updated documents. Use it at the start of a documentation review cycle, when preparing a support response, or when checking for changes that may affect a Project or operational workflow.
The available controls do not show an action that moves a document into or out of Recently Updated. The view reflects documents presented as recently updated.
Examples
A customer support agent needs to find the current guidance for a password-reset workflow before responding to a customer request.
Open Documents from the main navigation.
Select Published because the agent wants to review documentation presented as published.
In Search..., enter password reset.
Review the available matching documents and use the relevant published guidance for the customer request.
If no suitable document is displayed, select Recently Updated and search for password reset again to check whether a recent update is available.
If the team determines that password-reset documentation needs a dedicated grouping, select Add Category to begin adding a category for that documentation.
Tips
Tip: Use Recently Updated before a scheduled support, operations, or documentation review to identify content that may require attention.
Note: Use All when you are unsure of a document’s current view, then use Search... to narrow the list.
Warning: The screen provides Draft, Published, and Archived views, but no documented control for changing a document’s state. Do not describe a document as moved, published, archived, or restored unless the required action is available in the relevant workflow.
Troubleshooting
Symptom
Likely cause
Fix
The required document is not visible.
The current view is too narrow.
Select All to display all available documents, then use Search....
Search results are too broad.
The entered text is too general.
Enter a more specific feature name, workflow term, or document title in Search....
A recently changed document cannot be found in Published.
The document may be displayed in another available view.
Select Recently Updated, Draft, Archived, or All, then search again.
Documentation is difficult to organize consistently.
The workspace needs an additional grouping.
Select Add Category to begin the category-addition flow.
Was this page helpful?