StoneCreek Docs

KNOWLEDGE BASE

StoneCreek Docs

Find answers, setup guides, and step-by-step help.

StoneCreek Docs›Build and review the documentation plan

Build and review the documentation plan

Create a proposed documentation outline for a plugin, then review the suggested articles before generating them.

Use the documentation plan to turn a plugin analysis into a proposed table of contents. The plan gives you a structured list of articles with a title, section, purpose, evidence, and selection status so you can decide what should be created next.

Before you begin

  • Analyze a plugin ZIP first so there is a current analysis to work from.
  • Make sure you can access the StoneCreek Docs admin area.

Build the plan

  1. Open the StoneCreek Docs area in WordPress.
  2. Start the plan-building action for the current analysis.
  3. Wait for the proposed article list to be generated.

When the plan is ready, you will see a set of suggested articles. Each entry is organized to help you understand what the article covers and why it belongs in the documentation set.

Review the proposed articles

Check each proposed article for the following:

  • Title — the article name shown in the documentation set.
  • Section — where the article fits in the overall structure.
  • Purpose — the task or topic the article is meant to cover.
  • Evidence — the signals used to justify the article.
  • Selected — whether the article is marked for generation.

Use this review to confirm that the plan covers the major areas you want documented and that it does not include anything you do not want to publish.

Choose what to generate next

Keep the articles that support your documentation goals and remove any that are not needed. After you finish reviewing the plan, generate the selected articles to create draft documentation from the approved outline.

Tips for a clean documentation set

  • Prefer task-focused articles over broad topic pages.
  • Look for overlaps between suggested articles and merge or remove duplicates when needed.
  • Use the plan as a checkpoint before generating full article drafts.
Powered by StoneCreek Docs