15 KiB
Executable File
Scene: Report / Proposal
Goal
Generate a complete, formal, well-structured report ready for Word delivery. Must simultaneously meet:
- Complete structure, clear logic, formal language, definitive conclusions
- Objective data presentation, proper Word formatting
- Ready for presentation, filing, review, submission, or internal communication
Forbidden: Producing outlines-only / summaries / template annotations / half-finished drafts; outputting chat-style explanations or filler phrases like "here is the report content".
→ Font profile: A (Formal) — see references/common-rules.md
→ Default layout: standard margins — see references/common-rules.md
→ Placeholder convention — see references/common-rules.md
→ Universal prohibitions & quality checks — see references/common-rules.md
Report Type Routing
Auto-select structure and expression style based on user intent. If not explicit, infer from topic.
function selectReportType(keywords, topic) {
if (/analysis|competitor|industry|operations|data/.test(keywords)) return "analysis";
if (/experiment|lab|algorithm|engineering/.test(keywords)) return "experiment";
if (/test|QA|performance|security|compatibility/.test(keywords)) return "testing";
if (/survey|questionnaire|interview|market research/.test(keywords)) return "research";
if (/review|retrospective|post-mortem|summary/.test(keywords)) return "review";
if (/proposal|feasibility|implementation|optimization/.test(keywords)) return "proposal";
return "analysis"; // default
}
6 Report Types
| Type | Use Case | Structure Focus | Expression Focus |
|---|---|---|---|
| analysis | Industry/competitor/operations/data analysis | Background → Dimensions → Findings → Diagnosis → Recommendations | Conclusion-first, clear dimensions, chart-supported, actionable advice |
| experiment | Scientific/academic/algorithm/engineering experiments | Objective → Environment → Method → Results → Error → Conclusion | Precise process, clear conditions, objective results, conclusion ties to hypothesis |
| testing | Functional/performance/security/compatibility testing | Overview → Scope → Plan → Results → Defects → Risks → Conclusion | Data-driven, traceable, reproducible, supports go/no-go decisions |
| research | User/market/survey/interview research | Background → Subjects & Method → Sample → Findings → Synthesis → Recommendations | Clear sample boundaries, layered findings, recommendations match findings |
| review | Project/incident retrospective, phase summary | Goals → Review → Results → Issues → Lessons → Actions | Clear facts, restrained attribution, specific action items |
| proposal | Project/optimization proposal, feasibility study | Status → Goals → Solution → Roadmap → Resources → Risks → Benefits | Strong argumentation, executable plan, clear boundaries |
Standard Template Structures
Template A: Analysis Report
- Executive Summary
- Background & Objectives
- Scope, Data Sources & Methodology
- Core Findings
- Problem Diagnosis & Root Cause
- Conclusions & Recommendations
- Appendices (if needed)
Template B: Experiment Report
- Abstract
- Objective & Hypothesis
- Environment & Materials
- Procedure & Method
- Data & Results
- Error Analysis & Discussion
- Conclusions
- Appendices (if needed)
Template C: Testing Report
- Test Overview
- Test Scope & Environment
- Test Plan & Case Design
- Test Results Summary
- Defect Analysis & Distribution
- Risk Assessment & Outstanding Issues
- Test Conclusions
- Appendices (if needed)
Template D: Research Report
- Research Summary
- Background & Objectives
- Subjects & Methodology
- Sample & Data Description
- Core Findings
- Problem Synthesis
- Recommendations & Action Direction
- Appendices (if needed)
Template E: Review / Summary Report
- Overview
- Goals & Scope
- Process Review
- Results Summary
- Issues & Root Cause Analysis
- Lessons Learned
- Follow-up Action Plan
- Appendices (if needed)
Template F: Proposal / Feasibility Report
- Executive Summary
- Current State & Problem Analysis
- Goals & Expected Outcomes
- Solution Design
- Implementation Roadmap & Milestones
- Resource Requirements & Budget
- Risk Analysis & Mitigation
- Expected Benefits & Evaluation
- Appendices (if needed)
If the user provides a company/school/course template or fixed chapter requirements, always follow those first.
Input Recognition & Completion
User May Provide
Report topic, type, use case, audience, industry, length requirements, data sources, structure requirements, output purpose (presentation/filing/audit/review/external submission/coursework), template files, company/department/project/author/date, etc.
Processing Rules
- If the user provides a template, existing document, company standard, or format example, always follow it first
- If information is incomplete, fill in conservatively — completions must be restrained, natural, credible, professional
- Never fabricate unrealistic data, conclusions, test results, business metrics, project statuses, policy backgrounds, or customer feedback
- If critical information is missing and cannot be safely inferred, use standardized placeholders
- If no real data is available, prefer low-hallucination approaches: "status description → analysis framework → problem synthesis → recommendations"
Content Quality Constraints
Logic & Structure
- Report must revolve around a clear topic, objective, audience, and through-line
- Must not just pile up background/concepts/vague statements — must demonstrate analysis, synthesis, judgment, comparison, or review value
- Terminology must be consistent throughout — concepts must not drift
- Abstract, body, conclusions, and recommendations must be consistent — no self-contradiction
- Must form a complete loop: "background → objective → method/basis → process/status → findings/results → problems/judgment → recommendations/conclusions"
- Each major chapter must have a clear core conclusion or topic sentence — no information dump
Language Style
- Formal, objective, restrained, professional
- No colloquial expressions, chat tone, hyperbole, emotional language, or propaganda style
- For management/decision-maker audience: conclusion-first, highlight key points, actionable recommendations
- For technical/testing reports: clear basis, reproducible process, verifiable results, stated risks
Data Expression
- Never use vague expressions as main conclusions: "significantly improved", "obviously optimized", "performed well", "has certain issues"
- If data exists, express quantitatively (e.g., "average response time under 200 ms" not "fast response")
- First occurrence of a term: write full name with abbreviation, e.g., "Application Programming Interface (API)"
- Without real data backing, never fabricate precise figures
- Statements about facts, data, status, and results must be internally consistent
Truthfulness & Conservative Generation
- Never fabricate test results, experiment data, growth rates, customer counts, interview conclusions, sample distributions, or launch decisions
- Never present speculation as proven fact
- Never fabricate meeting minutes, regulatory bases, customer feedback, or system logs
- When information is insufficient, use placeholders — never pretend information is complete
- Conclusions must be restrained — do not overstate effects, risks, or value
- Recommendations must be grounded in preceding analysis — no conclusions from thin air
Chapter Content Requirements
(1) Cover
- Formal reports should have a cover page
- Cover includes: title, subtitle (if any), organization/department, author, date, classification (if requested)
- Cover must be a separate section
- Cover does not display page numbers
- Use
selectCoverRecipe()for recipe + palette (see design-system.md) - Common recipes: general report R1, whitepaper R2, consulting R3, proposal R4
(2) Executive Summary
- Formal reports must have a summary opening — never jump directly into details
- Summary should briefly state: background, objective, key methodology, key findings, main recommendations
- Suitable for quick reading by management — generally 200–400 words
- Must not read like a TOC description or pile of background filler
(3) Table of Contents
- Medium-to-long formal reports should include a TOC
- TOC must be generated from real heading styles (Heading + TOC field) — never write a fake TOC
- TOC page is typically a separate page
- TOC depth: usually 2–3 levels
(4) Background & Objectives
- Must explain why this report exists
- Must state what problem/scenario/audience the report serves
- If scope boundaries exist, state what the report does NOT cover
- Must not be vague/grand background — must relate directly to this report's task
(5) Methodology / Scope / Basis
- Must state what materials, criteria, methods, and time range the report is based on
- Analysis: data sources, analysis dimensions, criteria definitions
- Experiment: environment, materials, samples, procedure principles
- Testing: scope, version, environment, methods, coverage/rounds
- Research: sample source, sample size, research method, time range
- Reader must understand how conclusions were derived
(6) Core Content / Process / Status / Results
- Organized by logical or dimensional order — no chaotic piling
- Each section should lead with its conclusion, then expand with evidence
- Results must be specific — never just "performed well" or "has certain issues"
- Data, metrics, phenomena, and comparisons must be clearly stated
- If charts are needed but cannot be generated, use chart placeholders (see below)
(7) Analysis / Discussion / Problem Diagnosis
- Must not merely repeat earlier results
- Must explain what results mean, what patterns they reveal, what problems they expose
- May include: comparative analysis, root cause analysis, mechanism analysis, anomaly explanation, limitations, risk boundaries
- Analysis must be consistent with preceding data and facts
(8) Conclusions / Recommendations / Next Steps
- Conclusions must respond to report objectives
- Recommendations must be executable — not just principle slogans
- Recommendations should state: who executes, what to do, when, expected improvement
- Testing/review: clear verdict (pass / conditional pass / fail)
- Retrospective/summary: specific follow-up action items
(9) Appendices
- Supplementary material valuable to the report but not suitable for the main body
- Includes: raw data excerpts, detailed parameters, supplementary tables, sample screenshots
- Appendices should be on separate pages with proper headings
Chart Placeholder Convention
When charts are needed but cannot be directly generated:
[Chart Placeholder: Bar chart; Topic: Q1-Q4 2025 revenue comparison; X-axis: Quarter; Y-axis: Revenue (10K CNY); Style: clean business]
Rules:
- Specify: chart type, topic, axis meanings, key dimensions, optional palette suggestion
- Placeholder must be a standalone paragraph — never inline
- Never use vague placeholders like "insert chart here"
Prefer direct generation: Charts that can be produced via matplotlib should be generated as embedded PNGs. Placeholders are a fallback only.
Content-to-Word Mapping
Heading Levels
- Strict hierarchy — no level-skipping
- Headings must be informative — never "Background", "Content", "Other" (use "Project Background & Report Objectives" instead)
- Do not mix multiple numbering systems
- Normal paragraphs must not masquerade as headings
Paragraphs
- Do not use consecutive blank lines for visual spacing
- Each paragraph should be a complete semantic unit — not too long or too fragmented
Lists
- Use lists only when genuinely needed — an entire report must not be bullet points
- Nesting depth ≤ 3 levels
- Consistent punctuation within a list (all complete sentences or all fragments)
- Combine "key points" with "analysis paragraphs" — never just list without explaining
Tables
- Use tables only for structured data (statistics, comparisons, parameter lists)
- Every table must have a header row — headers must not be blank
- Avoid heavily merged-cell complex nested tables
- Tables must have introductory and explanatory text before/after
- Cell content should be concise — avoid long paragraphs inside cells
Emphasis
- Bold only for key conclusions, critical metrics, first occurrence of key terms
- Never bold entire paragraphs
- Avoid italic, strikethrough, and other unstable styles
Palette Selection
| Report Type | Suggested Palette |
|---|---|
| General | Neutral calm (primary: #101820) |
| Consulting | Warm terracotta |
| Tech | Cool dawn mist |
| Environment / Education | Warm sunshine |
| Medical | Cool mint |
See references/design-system.md for full palette definitions.
Document Structure
-
Cover — via
selectCoverRecipe()(see design-system.md)- Separate section, page margin typically 0
- Common: general R1, whitepaper R2, consulting R3, proposal R4
-
Table of Contents — H1–H3, separate section
-
Executive Summary — 1 page max
-
Body — Chapters per selected template (A–F)
-
Conclusions & Recommendations
-
Appendices — Raw data, detailed tables
Professional Elements
- Page numbers: bottom center, size 18, color "808080"
- Header: report title (abbreviated), size 18, color "808080"
- Figure/table numbering: sequential (Figure 1 / Table 1)
- Cover: no page number, no header/footer
- TOC: optional Roman numerals or no page numbers
- Body: Arabic numerals, continuous
Scene-Specific Quality Checks
In addition to universal checks (see references/common-rules.md):
Format
- Executive summary ≤ 1 page
- Figures/tables have captions ("Figure X: description" / "Table X: description")
- Cover recipe matches report type
- Data charts use palette accent color
Content
- Has executive summary — not starting directly with details
- Heading names are specific and meaningful
- Complete loop: background → basis → content → analysis → conclusions/recommendations
- No fabricated or exaggerated details
- Abstract and conclusions are consistent
- Terminology consistent throughout
- Data expressions are quantified, not vague
- Recommendations are actionable with owners and timeline
Structure
- Heading hierarchy has no level-skipping
- List nesting ≤ 3 levels
- Tables have headers with intro/explanation text
- Bold used sparingly for emphasis only