mirror of
https://github.com/hanzo-docs/team.git
synced 2026-10-30 18:59:50 +00:00
- Standalone Fumadocs (Next 16 static export) app, same stack as hanzo-docs org - 79 pages ported from upstream Huly docs, fully rebranded to Hanzo Team - Removed lead/inventory; added Account & billing (orgs/workspaces, usage, agents) - Login updated to Continue with Hanzo (hanzo.id) + Google/GitHub + email - CF Pages deploy workflow (org CF creds) -> docs.hanzo.team
25 lines
1.5 KiB
Plaintext
25 lines
1.5 KiB
Plaintext
---
|
|
title: Technical documentation
|
|
description: Learn how to create and manage technical documentation.
|
|
---
|
|
|
|
Technical documentation is part of the Controlled Documents module and is used for managing product development records, such as test reports and requirement documents.
|
|
|
|
## Creating a technical document
|
|
|
|
To create a new technical document, open the settings menu next to any product space within the `TECHNICAL DOCUMENTATION` submenu in the left sidebar and select `Create new document`. You can also click the `+ New document` button in the Controlled Documents module.
|
|
|
|
> **Note:** A new technical document can also be created as a child of any existing document.
|
|
|
|
Proceed through the following steps to create the document:
|
|
|
|
**Step 1:** Select a space and parent for your document. The space defines the roles and permissions that will apply; the parent simply determines where the document will be stored. A document can be the direct child of the space itself (at the top level of the space), or it can be a child of a document within that space.
|
|
|
|
**Step 2:** Select a template for your document. See our guide on [templates](/docs/controlled-documents/templates) for more information about how to create reusable templates for Controlled Documents.
|
|
|
|
**Step 3:** Provide details for your document, including a title, description, and reason for creation.
|
|
|
|
**Step 4:** Select team members that will be working on the document, including Co-Authors, Reviewers, and Approvers.
|
|
|
|
After proceeding through the above steps, click `Create Draft`.
|