Help-Doc
Formatting Content
Content Structure
Collection

Collection

A collection in TechDoc serves as a structured space for organizing your documentation. It acts as a container where you can store multiple pages and subpages, making it easier to manage API documentation and related content efficiently.

Creating a Collection

To start documenting in TechDoc, you first need to create a collection. Follow these steps:

  1. Click on your workspace name in the top left corner of the interface.

  2. From the dropdown menu, select Add Collection.

  3. Enter a name for your collection and click Save.

Once created, you can add any number of pages and subpages to structure your documentation effectively. A well-organized collection allows for better navigation and content management, ensuring a seamless experience for both authors and users.


🔹 Managing Your Collection: Collection Settings

TechDoc provides a range of collection settings to help you organize, update, and control your documentation. You can access these settings from the collection menu, allowing you to perform the following actions:

  • Rename – Modify the collection name.

  • Go to API Documentation – Directly access the published document URL.

  • Move – Transfer the collection to another workspace.

  • API Automation – Requires descriptions and sample responses to generate an automated workflow, without them automation will fail.

  • Export Collection – Supports export in OpenAPI and TechDoc formats.

  • Delete Collection – Deleted collections can be restored from Trash within 30 days.

Untitled design (12).png

Techdoc’s collection management system, you can efficiently create, maintain, and share your API documentation, ensuring a smooth workflow for your entire team. 🚀

Prev