Automatic Documentation Index¶

An Automatic Documentation Index is a dynamically generated navigation structure used to organize and access technical documentation.^[600-developer__index.md] It functions as a centralized entry point or "navigation map" (導航地圖), allowing users to efficiently locate specific topics or categories within a larger documentation set.^[600-developer__index.md]

Functionality¶

This type of index serves as the root or directory for specific domains, such as DevOps, providing links to subsections and related files^[600-developer__index.md]. Instead of manually curating links, the system automatically aggregates these references to form the index^[600-developer__index.md].

Examples¶

In a typical documentation hierarchy, an automatic index might reside at a root path (e.g., automatic/index.md) and provide access to sub-categories like Docker documentation^[600-developer__index.md].

Related Concepts¶

• Documentation Workflow
• Link pages and hub pages
• Atomic note principle

Sources¶

^[600-developer__index.md]