Skip to content

Commit 4c19c01

Browse files
committed
feat(docs): add ai-policy-editor page to documentation
1 parent 9ed9823 commit 4c19c01

File tree

4 files changed

+112
-0
lines changed

4 files changed

+112
-0
lines changed

packages/docs/ai-policy-editor.mdx

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
title: 'AI Policy Editor'
3+
description: 'Use AI to edit and improve organizational policies for SOC 2, ISO 27001, and GDPR compliance'
4+
---
5+
6+
### About AI Policy Editor
7+
8+
The AI Policy Editor is an intelligent assistant that helps you create, edit, and improve organizational policies. Built with deep knowledge of compliance frameworks like SOC 2, ISO 27001, and GDPR, the assistant understands governance, risk, and compliance (GRC) requirements and can help ensure your policies meet industry standards.
9+
10+
**Key Benefits:**
11+
12+
- **Natural Language Editing**: Describe changes in plain English and let AI handle the formatting
13+
- **Compliance Expertise**: Get suggestions aligned with SOC 2, ISO 27001, GDPR, and other frameworks
14+
- **Visual Diff Review**: See exactly what changed before applying any edits
15+
- **Non-Destructive Workflow**: Review and approve all changes before they're saved
16+
17+
### Getting Started
18+
19+
#### Step 1: Open the Policy Editor
20+
21+
1. Navigate to **Policies** in your organization dashboard
22+
2. Click on any policy to open it
23+
3. Select the **Editor View** tab
24+
25+
#### Step 2: Enable the AI Assistant
26+
27+
1. Click the **AI Assistant** button in the top-right corner of the editor
28+
2. A chat panel will appear on the right side of the screen
29+
3. You're now ready to start editing with AI
30+
31+
<Frame>
32+
<img src="/images/ai-policy-editor-assistant.png" alt="AI Policy Editor Assistant Panel" />
33+
</Frame>
34+
35+
### Using the AI Assistant
36+
37+
The AI assistant responds to natural language requests. Simply describe what you want to change, and the assistant will propose a complete updated version of your policy.
38+
39+
**Example Prompts:**
40+
41+
| Request Type | Example Prompt |
42+
| ------------------- | ------------------------------------------------------------------------------------ |
43+
| Add content | "Add a data retention section that specifies 7-year retention for financial records" |
44+
| Improve compliance | "Make this policy more SOC 2 compliant" |
45+
| Simplify language | "Simplify the language to be more readable" |
46+
| Add specifics | "Add specific roles and responsibilities for incident response" |
47+
| Framework alignment | "Update this to align with ISO 27001 Annex A controls" |
48+
49+
<Note>
50+
The AI always proposes complete policy content, not just fragments. This ensures formatting
51+
consistency and prevents accidental content loss.
52+
</Note>
53+
54+
### Reviewing Proposed Changes
55+
56+
When the AI proposes changes, you'll see a status indicator showing the progress:
57+
58+
- **Drafting**: The AI is preparing the updated policy
59+
- **Running**: The proposal is being processed
60+
- **Completed**: Changes are ready for your review
61+
62+
Once completed, a diff viewer appears below the editor showing:
63+
64+
- **Red lines**: Content being removed
65+
- **Green lines**: Content being added
66+
67+
<Frame>
68+
<img src="/images/ai-policy-editor-diff-viewer.png" alt="AI Policy Editor Diff Viewer" />
69+
</Frame>
70+
71+
#### Applying or Dismissing Changes
72+
73+
After reviewing the diff:
74+
75+
1. Click **Apply Changes** to accept the proposed edits
76+
2. Click **Dismiss** to reject the changes and keep your current content
77+
78+
<Tip>Click "View proposed changes" in the chat to quickly scroll to the diff viewer.</Tip>
79+
80+
### Best Practices
81+
82+
1. **Be Specific**: The more detail you provide in your request, the better the results. Instead of "improve this policy," try "add a section about password complexity requirements with 12-character minimum."
83+
84+
2. **Review Before Applying**: Always review the diff carefully before applying changes. The AI provides complete rewrites, so verify all sections are preserved as expected.
85+
86+
3. **Iterative Editing**: Make changes incrementally. Request one type of change at a time for easier review and better control over the final result.
87+
88+
4. **Ask Questions First**: If you're unsure what changes to make, ask the AI for suggestions. It can explain compliance requirements and recommend improvements before you commit to changes.
89+
90+
5. **Keep Policies Published**: Ensure your policies are published so other AI features (like Security Questionnaire) can reference the most current versions.
91+
92+
### Troubleshooting
93+
94+
**AI Assistant Not Appearing**
95+
96+
Ensure you're viewing the policy in **Editor View** mode, not PDF View. The AI assistant is only available in the editor.
97+
98+
**Changes Not Applying**
99+
100+
If changes fail to apply, check your network connection, ensure you have edit permissions for the policy, and try refreshing the page.
101+
102+
**Unexpected Content Changes**
103+
104+
If the AI modified sections you didn't intend to change, click **Dismiss** to reject the changes. Be more specific in your next request about which sections to modify, or reference sections by name.
105+
106+
### Support
107+
108+
For additional assistance with the AI Policy Editor:
109+
110+
1. Contact support at [support@trycomp.ai](mailto:support@trycomp.ai)
111+
2. Join our [Discord community](https://discord.gg/compai) for peer support

packages/docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"group": "Get Started",
1818
"pages": [
1919
"introduction",
20+
"ai-policy-editor",
2021
"automated-evidence",
2122
"device-agent",
2223
"security-questionnaire",
121 KB
Loading
321 KB
Loading

0 commit comments

Comments
 (0)