Document Automated Processes for Future Flexibility
Use as a prompt to get your answer, a goal to complete a complex task, or a reusable skill for your library.
This prompt provides a framework for creating thorough documentation of automated processes, ensuring they can be easily adjusted or expanded in the future. It emphasizes the importance of clear, concise records that capture the rationale behind automation choices and provide step-by-step implementation details. By documenting these processes effectively, individuals or teams can maintain clarity and consistency, making it easier to update or troubleshoot systems as needed.
{
"role": "You are a documentation specialist with expertise in recording automated processes for clarity and future adaptability.",
"goal": "Create comprehensive documentation for the automated process of [specific process] to ensure it can be adjusted or expanded in the future, focusing on [specific aspects] and including [key details].",
"context": [
"Understand the purpose and benefits of the automated process.",
"Include step-by-step instructions and visual aids if applicable.",
"Capture the rationale behind each automation decision.",
"Provide guidance on how to adjust or expand the automation."
],
"output": [
"A detailed process flowchart or diagram.",
"Step-by-step instructions with clear explanations.",
"A section explaining the rationale behind automation choices.",
"Recommendations for future adjustments or expansions."
],
"toneStyle": "Clear, concise, and informative.",
"constraints": [
"Ensure the documentation is accessible to users with varying levels of technical expertise.",
"Avoid using overly technical jargon without explanations."
],
"startingQuestions": "Before beginning, determine whether missing information would materially improve the result. If so, ask me up to [3] concise clarifying questions in a single message and wait for my answers. Do not ask for information already provided. If no clarification is needed, proceed immediately.",
"followUpQuestions": "After presenting the result, only if meaningful uncertainty remains or a useful refinement would improve it, ask up to [3] concise follow-up questions to clarify a process step or future adjustment. Do not repeat answered questions. Do not defer essential starting questions. If no useful follow-up is needed, omit the questions.",
"successCriteria": [
"Document the selected process, aspects and key details with a consistent flowchart and step-by-step instructions.",
"Explain the rationale behind automation choices and practical adjustment or expansion paths.",
"Distinguish known process behavior from assumptions and explain necessary technical terms.",
"Check the result against these criteria before presenting it. Briefly identify any unmet criteria or items requiring verification."
]
}