Structured Documentation Builder

Summary: The Structured Documentation Builder within the Antimanual ecosystem leverages AI to transform raw data into professional, consistent guides. Simply define your subject, configure settings, and generate structured content directly within your EazyDocs-powered WordPress site.

The Structured Documentation Builder is a tool within the Antimanual ecosystem. It turns raw notes and data into organized, easy-to-read guides. With AI, you can quickly create manuals and lessons without the hassle of outlining or writing every section by hand. This ensures your documentation stays consistent and professional across your entire site.

Note: Documentations are custom post types which are managed by the EazyDocs plugin, so make sure the EazyDocs plugin is installed and activated in your site.

Choosing Your Mode

First, pick the right mode for your project:

• New Documentation Root: Start a brand-new manual or category from scratch.
• Sub-lesson Addition: Add new sections to an existing guide while keeping the same tone and context.

Next, define your main topic (Documentation Subject). This subject acts as a guide for the AI, keeping your content focused.

Settings and SEO

After defining your topic, adjust these settings to make sure your content is easy to find:

• Post Data: Set the language and choose if the posts should be “Draft” or “Published.”
• Structure Control: Tell the AI exactly how many lessons you need, or let it decide based on the topic’s complexity.
• SEO Parameters: Add keywords to help your site rank better.

Style and Audience

Your documentation needs to match your reader’s needs. The builder lets you customize the tone and technical level:

• Pick an Audience: Choose from Developers, End Users, Administrators, or a General audience.
• Set Content Depth: Select “Concise” for quick facts, “Balanced,” or “Comprehensive” for detailed manuals.

Choosing Your Data

The builder gathers information in two ways:

• Global Knowledge Base: Uses your existing site content, PDFs, and links.
• Upload Files: Ideal for new software releases or private documents that aren’t on your site yet.

Review and Create

Before the final pages are written, the tool creates an outline for you to review. You can easily:

• Move lessons around.
• Rename chapters.
• Remove parts you don’t need.

Once you are happy with the outline, click the generate button to have the AI write the full content automatically.

Frequently Asked Questions