Overview
Rockumentation can work well with AI-assisted writing and research, but the goal is still to help people maintain clear documentation. Think of AI as a drafting assistant that can help you find information, organize it, and suggest revisions while your team stays responsible for the final wording.
The most effective use of AI in Rockumentation is usually small and focused. Instead of asking it to rewrite an entire book at once, ask it to improve one article, one section, or one specific problem at a time.
What AI Can Help With
- Finding the article that already answers a question.
- Summarizing a long article before you decide what to revise.
- Drafting a clearer introduction, procedure, or policy explanation.
- Turning rough notes into headings, paragraphs, lists, and callouts.
- Preparing updates for a new documentation version.
Working Safely
AI works best when you give it a clear goal and a limited scope. For example, ask it to tighten wording, add a warning callout, convert a paragraph into a list, or suggest a better section order. This makes the results easier to review and reduces the chance of changing unrelated content.
Structured articles are especially good for this style of editing because they are made of separate content blocks. That makes it easier for AI-assisted workflows to update one part of an article without disturbing the rest of the page.
Content That Usually Works Well
- Headings and section organization
- Paragraphs and short explanatory text
- Bulleted and numbered lists
- Tables, quotes, code samples, and alert callouts
- Embed blocks and child article tables of contents when you already know where they belong
Note
Images, highly customized layouts, and advanced Raw HTML or Lava content usually need extra human review. AI can still help describe or plan these changes, but a person should verify the final result carefully.
Permissions and Versioning
AI assistance follows the same access rules as the person using it. If you cannot view an article, publish a version, or edit locked content yourself, AI assistance cannot do those things for you either.
This makes unpublished versions a good place to prepare larger revisions. Your team can draft and review changes there before publishing them for general readers.
Review Expectations
Important
Always review AI-generated changes before you publish them. Check links, headings, table data, code samples, and any policy or legal wording to be sure the final article says exactly what you intend.
Prompting Tips
- Ask for one specific outcome, such as a clearer introduction, a shorter paragraph, or a better section order.
- Name the audience when it matters, such as first-time staff, volunteers, or administrators.
- Tell the AI what to preserve, such as policy meaning, existing links, or a required warning.
- Prefer article-by-article or section-by-section requests over book-wide rewrites.
- Always review the final output before publishing, especially for policy, legal, or process-sensitive content.
Example Requests
- Find the article that explains volunteer background checks.
- Rewrite this section so it is easier for first-time staff to understand.
- Turn these three paragraphs into a short checklist.
- Add a warning callout before the upload steps.
- Prepare a draft of this article for the next handbook version.