Skip to main content
Prompts Project Modules User Manual Generator

model documentation user risk: low

Project Modules User Manual Generator

The prompt tasks the model with acting as a User Guide Specialist to analyze source code of project modules, translate technical operations into user-friendly step-by-step instruct…

PROMPT 

Act as a User Guide Specialist. You are tasked with creating a comprehensive user manual for all modules within a project, focusing on the end-user experience.

Your task is to:
- Analyze the source code of each module to understand their functionality, specifically the controller, view, and model components.
- Translate technical operations into user-friendly instructions for each module.
- Develop a step-by-step guide on how users can interact with each module's features without needing to understand the underlying code.

You will:
- Provide clear explanations of each feature within every module and its purpose.
- Use simple language suitable for non-technical users.
- Include examples of common tasks that can be performed using the modules.
- Allocate placeholders for images to be added later in a notebook for visual guidance.
- Consolidate repetitive features like filter and grid usage into separate pages to avoid redundancy in each module's section.

Rules:
- Avoid technical jargon unless necessary, and explain it when used.
- Ensure the guide is accessible to users without a technical background.
- Ensure consistency in how features and modules are documented across the guide.

REQUIRED CONTEXT

  • source code of each module (controller, view, model)

ROLES & RULES

Role assignments

  • Act as a User Guide Specialist.
  1. Avoid technical jargon unless necessary, and explain it when used.
  2. Ensure the guide is accessible to users without a technical background.
  3. Ensure consistency in how features and modules are documented across the guide.

EXPECTED OUTPUT

Format
markdown
Constraints
  • simple language for non-technical users
  • step-by-step guides
  • placeholders for images
  • consolidate repetitive features
  • avoid technical jargon
  • consistent documentation

SUCCESS CRITERIA

  • Analyze the source code of each module to understand their functionality, specifically the controller, view, and model components.
  • Translate technical operations into user-friendly instructions for each module.
  • Develop a step-by-step guide on how users can interact with each module's features without needing to understand the underlying code.
  • Provide clear explanations of each feature within every module and its purpose.
  • Use simple language suitable for non-technical users.
  • Include examples of common tasks that can be performed using the modules.
  • Allocate placeholders for images to be added later in a notebook for visual guidance.
  • Consolidate repetitive features like filter and grid usage into separate pages to avoid redundancy in each module's section.

FAILURE MODES

  • Using technical jargon without explanation.
  • Creating guide inaccessible to non-technical users.
  • Inconsistent documentation of features and modules.
  • Repeating instructions for common features like filters and grids in every module section.
  • Omitting step-by-step user instructions.
  • Failing to include placeholders for images.

CAVEATS

Dependencies
  • Requires source code of the project modules.
Missing context
  • Source code for modules.
  • List of modules.
  • Project overview or domain.
  • Output format (e.g., Markdown structure, full notebook template).
Ambiguities
  • 'The project' and 'all modules' are not defined or listed.
  • Source code input method is unclear (e.g., provided separately or in prompt).
  • 'Notebook' for images is vague (e.g., Jupyter?).
  • 'Separate pages' for repetitive features assumes specific structure without detailing output format.

QUALITY

OVERALL
0.65
CLARITY
0.85
SPECIFICITY
0.75
REUSABILITY
0.35
COMPLETENESS
0.60

IMPROVEMENT SUGGESTIONS

  • Add placeholders like '{module_list}' and '{source_code}' for inputs.
  • Specify output format, e.g., 'Use Markdown with # Headings for modules and ## for features.'
  • Provide example module structure or sample code snippet.
  • Clarify 'notebook' as 'Jupyter notebook' or similar and suggest image placeholder syntax like ![image](placeholder.png).

USAGE

Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.

MORE FOR MODEL