Skip to content
D
Documentation

Projects

guide
3 min readUpdated

Applications › App

Projects
Resend email

Overview

Projects are organized workspaces or initiatives that contain related documentation and assets. Use the Projects area to locate existing project records, begin a new project, and remove projects that are no longer required. Documentation managers, technical writers, customer support agents, product or operations managers, and workspace administrators can use this area when organizing work by initiative.

Workflow

Decide whether to work with an existing project or create a new one

  1. Open Projects from the main navigation.

    Projects
New Project
Dismiss
  1. To locate an existing project, enter relevant text in Search projects.... Review the matching projects shown in the list.

  2. If the required project is not available, select New Project to begin creating a project. Complete the information requested on the next screen before continuing your work in that project.

Note: Use a specific and recognizable project name when creating a project so that other members of the Organization can find the correct workspace through project search.

Decide whether to keep or remove a project

  1. When a project is no longer needed, select the project to be removed and use Delete.

  2. If the project should remain available, do not delete it. Return to Projects and use Search projects... whenever you need to locate it again.

Warning: Delete is intended for removing a project. Confirm that you have selected the correct project before using this action.

Respond to visible interface messages

  1. If the Projects screen displays a message related to email delivery, use Resend email to send the email again, or select Dismiss to close the message.

  2. Use Menu only when you need the additional options made available by the screen.

Examples

A documentation manager is preparing a workspace for an upcoming customer onboarding initiative called Northwind Onboarding.

  1. The manager opens Projects.

    Projects
New Project
  1. The manager enters Northwind Onboarding in Search projects... to confirm that a project with that name does not already exist.

  2. Because no suitable existing project is found, the manager selects New Project and completes the information requested in the project creation screen.

  3. Later, the manager returns to Projects and uses Search projects... to find the Northwind Onboarding project when documentation and related assets need to be organized for that initiative.

  4. If a duplicate project is later identified, the manager selects the duplicate and uses Delete, while retaining the project that the team is actively using.

Tips

Tip: Search before creating a project to reduce the risk of duplicate project workspaces.

Tip: Keep project names consistent with your Organization's initiative or customer naming conventions to make searches more reliable.

Warning: Do not use Delete for a project that may still be needed by writers, support agents, or operations teams.

Troubleshooting

SymptomLikely causeFix
You cannot find a project in the list.The project may not match the text entered in Search projects....Try a shorter or different search term, then review the available projects.
A message indicates that an email needs attention.The email may need to be sent again.Select Resend email. If no action is required, select Dismiss to close the message.
You are concerned about removing the wrong project.The incorrect project may be selected before using Delete.Stop before deleting and verify that the selected project is the one intended for removal.

Was this page helpful?