StoneCreek Docs

KNOWLEDGE BASE

StoneCreek Docs

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

StoneCreek Docs›Set OpenAI and documentation preferences

Set OpenAI and documentation preferences

Enter your OpenAI API key, choose a model, and set the writing preferences used when StoneCreek Docs generates documentation.

Use these settings to connect StoneCreek Docs to OpenAI and shape the style of the content it produces. Once the connection is in place, you can choose the model and set the tone, audience, and level of detail used for generated documentation.

Before you begin

  • Make sure you have an OpenAI API key ready.
  • Only users who can manage the plugin settings should make these changes.

Set up your OpenAI connection

  1. Open the StoneCreek Docs settings area in your WordPress dashboard.
  2. Enter your OpenAI API key.
  3. Choose the model you want StoneCreek Docs to use for generation.
  4. Save your changes.

If the OpenAI API key is not configured, StoneCreek Docs cannot send requests to OpenAI.

Choose how documentation should read

StoneCreek Docs uses your writing preferences to guide the generated content. Set these options to match the way you want your documentation presented.

  • Company: Use the name you want reflected in the documentation voice or branding.
  • Audience: Describe who the documentation is for, such as site owners or event organizers.
  • Tone: Choose the overall style you want the documentation to use.
  • Detail level: Control how much information the generated article should include.

Pick the right detail level

The detail level helps you match the length and depth of your documentation to the task.

  • Concise keeps the article focused on only what is needed to complete the task.
  • Standard provides a complete user-facing guide with the main steps and important choices.
  • Comprehensive gives a full walkthrough with useful context, steps, cautions, and related tasks.

Save and use your preferences

  1. Review your settings before saving.
  2. Save the configuration.
  3. Generate or update documentation so the new OpenAI and writing preferences take effect.

If you change the model, audience, tone, or detail level later, save the settings again before generating new content.

Tips

  • Use a model that fits the kind of output you want to produce.
  • Keep the audience and tone aligned with the people who will read the documentation.
  • Use a lower detail level when you want shorter articles and a higher detail level when you need fuller guidance.
Powered by StoneCreek Docs