Site Tools


quantum-writing-guide

**This is an old revision of the document!**

Quantum Computing Article Writing Guide

Writing conventions for quantum computing topics (gates, states, algorithms, concepts).

Article structure

  1. Opening paragraph: bold term, 2–3 sentence definition, context and importance
  2. Definition: mathematical formalism, matrix representation (for gates/states)
  3. Subsections: Properties, Applications, Implementation, Scalability, Relations (choose relevant ones)
  4. Cross-references: links to related concepts

Example opening:

Quantum Fourier Transform is an $n$-qubit unitary gate mapping computational basis state $|j\rangle$ to a superposition with phases determined by $j$. It is the quantum analogue of the discrete Fourier transform and appears in Shor's factoring and phase estimation algorithms.

Math notation

  • Inline: $|\psi\rangle$, $n$ qubits (use Unicode angle brackets, not LaTeX)
  • Block equations: matrices, major formulas (blank lines before/after)
  • Kets: |ψ⟩ (Unicode), not \langle/\rangle
  • Operators: plain text or bold by emphasis (e.g., Z operator, `CNOT gate)
  • Matrices: use \begin{pmatrix}...\end{pmatrix}

Sections by type

Gates: Definition, Properties, Circuit Implementation, Applications, Scalability, Relations

States: Definition, Properties, Construction, Measurement, Applications, Relations

Algorithms: Problem statement, Overview, Quantum Subroutines, Complexity, Applications, Limitations, Relations

Formatting

  • Lists: use - **term**: description format with blank line before
  • Bold: mark first mention of key terms in each section
  • Internal links: use [[article-id|Display Text]] in body text, never in headings
  • Headings: sentence case, never title case (first word capitalized, rest lowercase unless proper nouns)
  • Article titles: sentence case, not title case

Scope

Always: definition, formalism, applications, relations, scalability

When relevant: matrix representations, circuit diagrams (text descriptions), implementation details, approximations

Omit: proofs and derivations, historical anecdotes, trivial asides, “in conclusion” summaries

Tone

Technical but approachable. Short paragraphs (3–6 sentences). Neutral (“is used in” not “is important for”). No superlatives or marketing language.

Definition templates

Gate: [Name] is an $n$-qubit gate that [action]. Its matrix is [form]. It is [Clifford/non-Clifford, self-inverse, etc.].

State: [Name] is an $n$-qubit state where [property]. It is an eigenstate of [operator] with eigenvalue [value]. Applications: [algorithms/protocols].

Concept: [Name] is the set of [gates/states] where [defining property]. Examples: [list].

Common mistakes to avoid

  • Starting with “This article…” instead of being direct
  • Omitting definition or mathematical formalism
  • Inconsistent notation (choose ket style early)
  • Missing scalability analysis
  • Embedding links in headings
  • Over-explaining basics instead of linking to them
  • No applications mentioned
  • Generic opening paragraph

Before publishing

  • Definition links to foundational concepts
  • Applications mention relevant algorithms/protocols
  • Relations section links to similar concepts
  • Scalability mentioned
  • Key terms bolded on first mention
  • Math notation consistent (Unicode kets)
  • No dead links
quantum-writing-guide.1787759025.md.gz · Last modified: by 127.0.0.1