Prompt lesson · 20 prompts
Technical Documentation prompts for Systems Analysts
20 ready-to-use prompts from our AI for Systems Analysts course. Copy one, fill in the {{placeholders}}, and paste it into ChatGPT, Claude, Gemini or any other AI.
Create User Manuals
Use this when you need to create clear, step-by-step user manuals for software or systems.
Role You are a technical documentation specialist who creates user manuals that are clear, concise, and easy to follow, optimizing for user comprehension and task success.
Context you provide
- {{software/system name}}: The name of the software or system.
- {{audience}}: The intended users (e.g., end-users, IT staff).
- {{key features}}: The main features or functions to cover.
- {{common issues}}: Any known issues or troubleshooting topics to include.
Instructions
- If any of the above context is missing, ask for it before proceeding.
- Structure the manual with an introduction, system requirements, installation instructions, step-by-step usage guides for each key feature, and a troubleshooting section.
- For each step, use clear, action-oriented language and indicate where screenshots or diagrams would be helpful.
- Include a FAQ section addressing common questions and issues.
- Write in plain language suitable for the specified audience, avoiding jargon unless defined.
Output format Provide the manual in Markdown with headings, numbered steps, and bullet points. Keep it between 800-1500 words. Use a professional and friendly tone.
Guardrails
- Do not invent features or steps not provided; if unsure, mark as [verify].
- Flag any assumptions about the audience's technical level.
- Stay within the scope of the provided software/system and features.
Example {{software/system name}} = 'ProjectFlow', {{audience}} = 'project managers', {{key features}} = 'task creation, team collaboration, reporting', {{common issues}} = 'login problems, notification delays'.
Open this prompt Writing · Intermediate
Write System Specifications
Use this when you need to document technical requirements and specifications for a system, including functional, performance, security, and integration aspects.
Role You are a systems analyst and technical writer who translates complex requirements into clear, structured specifications that guide development and stakeholder alignment.
Context you provide
- {{system-name}}: The name of the system.
- {{functional-requirements}}: Key features and capabilities.
- {{performance-metrics}}: Expected response times, throughput, scalability.
- {{security-requirements}}: Encryption, access controls, compliance.
- {{integration-requirements}}: Existing software, protocols, data formats.
Instructions
- Ask for missing context before starting.
- Structure the document with sections: Overview, Functional Requirements, Performance Requirements, Security & Privacy, Integration Requirements, and Assumptions.
- For each requirement, use clear, testable statements (e.g., "The system shall...").
- Prioritize requirements as Must-Have, Should-Have, or Nice-to-Have.
- Include measurable metrics where possible.
- Flag any ambiguous or missing information.
Output format A Markdown document with headings, bullet lists, and tables for requirements. Tone should be formal and precise.
Guardrails
- Do not invent requirements; use only provided context.
- Distinguish between requirements and assumptions.
- Stay within the scope of the specified system.
Example {{system-name}}: Customer Portal; {{functional-requirements}}: user login, profile management, order history; {{performance-metrics}}: <2s response time, support 1000 concurrent users; {{security-requirements}}: HTTPS, role-based access; {{integration-requirements}}: REST API with existing CRM.
Open this prompt Writing · Advanced
Document Software Architecture
Use this when you need to explain or document the architecture of a software system for various stakeholders.
Open this prompt Writing · Intermediate
Write API Documentation
Use this when you need to create comprehensive documentation for API endpoints, including parameters, examples, and error handling.
Open this prompt Writing · Advanced
Generate Release Notes
Use this when you need to summarize software updates into clear, user-friendly release notes.
Open this prompt Writing · Beginner
Technical Diagram Creator
Use this when you need to create visual representations of system architecture, data flows, or network infrastructure to aid understanding and communication.
Open this prompt Creating · Intermediate
Write Installation Guides
Use this when you need to create step-by-step installation guides for software or systems across different environments.
Open this prompt Writing · Intermediate
Document Troubleshooting Procedures
Use this when you need to create clear and effective troubleshooting guides for common technical issues.
Open this prompt Writing · Intermediate
Create Standard Operating Procedures
Use this when you need to develop clear, step-by-step standard operating procedures for IT or operational tasks.
Open this prompt Creating · Beginner
Document System Architecture
Use this when you need to create or update documentation that explains the structure and interactions of your technical systems.
Open this prompt Analysis · Advanced
Write User Manuals
Use this when you need to create user-friendly manuals for software tools or systems.
Open this prompt Writing · Intermediate
API Documentation Generator
Use this when you need to create or improve API documentation for your systems, ensuring it is comprehensive and user-friendly.
Open this prompt Writing · Intermediate
Create Data Flow Diagrams
Use this when you need to visualize how data moves through a system or process.
Open this prompt Creating · Intermediate
Document Network Infrastructure Layout
Use this when you need to create or update comprehensive documentation of your network's physical and logical structure.
Open this prompt Creating · Intermediate
Change Management Documentation
Use this when you need to create, structure, or improve documentation for system changes, ensuring clarity and compliance.
Open this prompt Writing · Intermediate
Develop Disaster Recovery Plans
Use this when you need to create a comprehensive disaster recovery plan for your systems and operations.
Open this prompt Planning · Advanced
Draft Security Policies and Procedures
Use this when you need to create or update technical security policies and procedures for compliance or operational clarity.
Open this prompt Writing · Intermediate
Create Troubleshooting Guides
Use this when you need to create structured troubleshooting guides for technical issues, including diagnostics and fixes.
Open this prompt Creating · Intermediate
Compliance Documentation Builder
Use this when you need to create or update documentation that demonstrates adherence to technical regulations and standards.
Open this prompt Writing · Intermediate
Develop Training Materials
Use this when you need to create effective training materials for employees on a new system or process.
Open this prompt Creating · Intermediate