Structured Documentation Builder

The Structured Documentation Builder is a sophisticated module within the Antimanual ecosystem designed to transform raw data and knowledge base entries into organized, hierarchical documentation. By leveraging advanced AI, this tool allows administrators to create comprehensive manuals, guides, and lessons that are logically structured and ready for public consumption. This system eliminates the manual labor of outlining and drafting complex technical documents, ensuring consistency in tone and information density across your entire site.

[toc]

Defining Subject and Mode

The first stage of the builder focuses on the core identity of the documentation you intend to create. Users must choose between two distinct operating modes to suit their project needs:

• New Documentation Root: Select this mode to create a brand-new top-level manual or knowledge base category from scratch.
• Sub-lesson Addition: Use this mode to extend an existing documentation post, allowing the AI to generate supporting sub-sections that maintain the context of the parent article.

During this phase, you must state the primary topic or subject of the guide. This input acts as the “north star” for the AI, ensuring that every generated lesson remains relevant to the overarching theme. For more information on preparing your data for this step, refer to Managing User Roles and Access in Docy: Best Practices and Plugin Recommendations.

Configuration and SEO Settings

Once the subject is defined, the builder moves to technical settings. This step ensures that the generated documentation is not only readable but also optimized for search engines and site architecture. Key configurations include:

• Post Data: Define the output language and the initial status of the posts (Draft or Published).
• Structure Control: You can specify an exact lesson count or allow the AI to dynamically determine the optimal number of sub-lessons based on the complexity of the subject.
• SEO Parameters: Assign focus keywords and optimization instructions so the builder can structure content in a way that aligns with your The Upsides and Downsides of Creating a Custom WordPress Theme.

Writing Style and Audience Persona

Documentation is only effective if it speaks the language of its readers. The Structured Documentation Builder provides granular controls for tone and technicality. You can select from several audience personas, including Developers, End Users, Administrators, or a General audience.

Furthermore, the Content Depth setting allows you to toggle between “Concise” (ideal for quick reference), “Balanced,” or “Highly Comprehensive” (best for deep-dive technical manuals). For example, a developer-facing API guide would benefit from a “Highly Comprehensive” depth with a “Technical” tone, whereas a basic user FAQ might remain “Concise” and “General.”

Knowledge Source Selection

The builder can pull information from two primary sources. You can either utilize the Global Knowledge Base, which contains all indexed WordPress posts, PDFs, and crawled URLs, or you can upload specific files. This latter option is particularly useful for generating documentation for a new software release where the specifications exist only in a localized document and haven’t yet been added to the broader site index.

Generation and Human Review

Before any final pages are created, the system generates a Documentation Outline. This acts as a scaffolding that represents the proposed hierarchy of lessons. At this stage, you are presented with a review interface where you can:

• Rearrange the order of sub-lessons.
• Manually rename chapters or topics.
• Remove irrelevant sections or add custom manual placeholders.

Clicking the final execution button will then trigger the AI to write the full content for each node in the outline, saving them directly as WordPress posts or custom documentation types.

Frequently Asked Questions

Can I use this to document code repositories?
Yes. By syncing your GitHub account first, the builder can pull from README files and markdown documentation to create a structured web-based manual.

How does the builder handle internal linking?
The builder automatically structures hierarchy using parent-child relationships in WordPress. For more advanced contextual linking, you may want to use the tool after the documentation is generated.

Is there a limit to how many lessons I can generate?
While the AI can dynamically generate a large number of nodes, it is recommended to review outlines larger than 20 lessons to ensure topical focus remains sharp.