documentation v1.0.0 350 words

Scientific Report Standard — LaTeX PDF Generation

Source: doc

Scientific Report Standard

Generate comprehensive scientific reports in PDF using LaTeX, with automatic Chinese/English language selection.

Language Selection

Report Structures

Research / Experiments (IMRAD)

  1. Abstract
  2. Introduction (background, motivation, objectives)
  3. Related Work (optional)
  4. Methodology (system design, algorithms, implementation)
  5. Experiments (setup, data, evaluation metrics)
  6. Results (data presentation, analysis)
  7. Discussion (findings, limitations, future work)
  8. Conclusion
  9. References

Systems / Projects

  1. Overview
  2. System Architecture
  3. Core Components
  4. Implementation
  5. Usage Examples
  6. Performance Evaluation
  7. Summary

LaTeX Template (Chinese)

\documentclass[11pt,a4paper]{article}
\usepackage[UTF8]{ctex}
\usepackage{amsmath,amssymb,amsthm}
\usepackage{geometry}
\usepackage{graphicx}
\usepackage{booktabs}
\usepackage{longtable}
\usepackage{hyperref}
\usepackage{xcolor}
\usepackage{algorithm}
\usepackage{algorithmic}
\usepackage{enumitem}
\usepackage{fancyhdr}
\usepackage{tcolorbox}
\usepackage{listings}

\geometry{margin=2.5cm}
\hypersetup{colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue}

\pagestyle{fancy}
\fancyhf{}
\rhead{项目报告}
\lhead{系统名称}
\rfoot{\thepage}

\author{Viska Wei}
\date{\today}

Compilation Rules

Language Engine Command
Chinese (ctex) XeLaTeX xelatex report.tex && xelatex report.tex
English pdfLaTeX pdflatex report.tex && pdflatex report.tex

Always compile twice for table of contents and cross-references.

Formatting Rules

  1. Author: Always use "Viska Wei"
  2. Margins: 2.5cm (\geometry{margin=2.5cm})
  3. Font size: 11pt base
  4. Paper: A4
  5. Hyperlinks: Blue colored links enabled
  6. Executive summary: Use tcolorbox for key findings at the top
  7. Table of contents: Always include after title page
  8. Code listings: Use listings package with syntax highlighting
  9. Tables: Use booktabs (\toprule, \midrule, \bottomrule)
  10. Figures: \includegraphics[width=0.8\textwidth]{...} default width

Code Listing Style

\lstset{
  basicstyle=\ttfamily\small,
  backgroundcolor=\color{codebackground},
  breaklines=true,
  frame=single,
  numbers=left,
  numberstyle=\tiny\color{gray},
  keywordstyle=\color{blue},
  commentstyle=\color{green!60!black},
  stringstyle=\color{orange},
  showstringspaces=false
}

Quality Checklist

Skills Using This Standard (1)

doc