Docs & technical writing
AuraScore 83/100

Laboratory Manual Technical Documentation Standard Update

Instruct STEM course authors and lab instructors on revised laboratory manual authoring and safety standards.

Use this template when distributing updated authoring workflows, accessibility criteria, and safety documentation mandates to lab coordinators and STEM teaching staff ahead of a new academic term.

Template

Role: Academic Documentation Quality Lead specializing in instructional design standards, laboratory manual authoring, and accessibility compliance across higher education STEM departments.

Context

  • Academic unit: {{academic_department}}
  • Upcoming curriculum delivery cycle: {{curriculum_cycle}}
  • Documentation standard release: {{standard_version}}
  • Required accessibility and safety mandates: {{accessibility_mandates}}
  • Draft finalization deadline: {{submission_deadline}}
  • Collaborative authoring tool: {{review_workflow_tool}}

Task

Compose an instructional technical guidance email to lab instructors and course authors, communicating the newly revised style guide, safety documentation rules, and editorial review workflow.

Method

  1. Analyze {{accessibility_mandates}} to extract core formatting rules for figures, tables, and hazard warnings.
  2. Craft an informative subject line indicating the authoring cycle and documentation mandate.
  3. Contextualize the release of {{standard_version}} in relation to student safety and instructional quality for {{academic_department}}.
  4. Detail the structural updates required for laboratory protocols, apparatus diagrams, and hazard data sheets.
  5. Clarify authoring expectations inside {{review_workflow_tool}}, specifying tag usage and peer-review stages.
  6. Lay out the milestone calendar leading up to {{submission_deadline}}.
  7. Supply authoring templates, automated linting instructions, and editorial support contacts.

Constraints

  • MUST clearly distinguish between safety compliance requirements and general stylistic recommendations.
  • MUST NOT use informal phrasing; maintain a rigorous pedagogical and editorial standard.
  • All milestones MUST include explicit dates or relative timeframes.
  • Email length must not exceed 450 words.

Output format

  1. Email Subject Line
  2. Purpose & Pedagogical Context (1 short paragraph)
  3. Core Documentation & Accessibility Standards (bulleted requirements)
  4. Authoring & Review Workflow in the target tool (numbered sequence)
  5. Timeline, Deadlines & Editorial Support (closing summary)

Self-review

  • Check that safety and accessibility requirements are explicitly listed.
  • Verify that all context variables are seamlessly integrated.
  • Ensure the step-by-step workflow in the authoring tool is actionable for course authors.
AuraScore breakdown
83/100Provisional
Instruction clarity15/15 · Strong

Explicit role, a named task, and discrete steps the model can follow.

Context architecture12/12 · Strong

Background, inputs and variables the model needs before it starts.

Constraint engineering12/12 · Strong

Hard boundaries — what the model must and must not do.

Output specification6/14 · Thin

A named, field-level shape for the response.

Reasoning structure10/10 · Strong

Ordered work items that force analysis before an answer.

Model compatibility10/10 · Strong

Length and structure that travel across frontier models.

Token efficiency7/10 · Adequate

Signal density — instruction weight without padding.

Reusability7/7 · Strong

Documented variables so the scaffold adapts to new inputs.

Robustness3/5 · Adequate

Quality bar, assumptions and behaviour when inputs are thin.

Observed performance1/5 · Thin

How much real usage the template has behind it.

writing-content
writing-docs
education-research
curriculum-docs
stem-education
style-guide