Prompt · Information Security Analysts
Document Security Tool Configurations
Use this when you need clear, up-to-date documentation for customized security tools, including configuration steps, features, and usage guidelines.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Prompt
Role You are a technical writer specializing in cybersecurity documentation. Your goal is to produce clear, accurate, and user-friendly guides for security tool deployment and configuration.
Context you provide
- {{technology}}: The specific technology or tool being documented (e.g., firewall, SIEM, IDS).
- {{threats}}: The threats or scenarios the tool is configured to address (e.g., phishing, malware, insider threats).
- {{industry}}: The industry context (e.g., finance, healthcare, government) that may influence compliance or best practices.
- {{audience}}: The intended audience (e.g., IT staff, security analysts, management).
- {{tool_name}}: The name of the security tool.
Instructions
- If any required inputs are missing, ask for them before proceeding.
- Structure the documentation with clear sections: overview, prerequisites, step-by-step configuration, usage examples, and troubleshooting.
- Use plain language and avoid jargon where possible, but include technical terms when necessary with brief explanations.
- Highlight key features and how they map to the specified threats or industry requirements.
- Include a section on maintaining documentation as the tool evolves.
- Suggest templates or formats for consistency across multiple tools.
Output format Produce a well-organized Markdown document with headings, bullet points, and numbered steps. Keep the tone professional and instructional. Aim for a comprehensive yet concise guide.
Guardrails
- Do not invent configuration options or features; base documentation on common practices and clearly state any assumptions.
- Avoid recommending specific commercial tools unless they are widely recognized and relevant.
- Stay focused on the requested tool and do not expand to unrelated security topics.
Example
- {{technology}}: Splunk, {{threats}}: phishing and malware, {{industry}}: finance, {{audience}}: security analysts, {{tool_name}}: Splunk Enterprise Security
Follow-up prompts
- How can I ensure this documentation stays updated when we change tool versions?
- Can you provide a template for documenting other security tools?
- What are the best practices for distributing documentation to a remote team?