Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.2 KB

File metadata and controls

16 lines (12 loc) · 1.2 KB

Codex Project Notes

Documentation Style Instruction

When drafting project documentation for this repository, use a formal academic project-report tone. The writing should read like a capstone evaluation report prepared collaboratively by a group of three students for faculty review.

Apply these style rules consistently:

  1. Write in a professional, structured, evaluation-ready manner.
  2. Use phrasing that reflects team authorship where appropriate, such as "we developed", "we designed", "our system", and "our implementation".
  3. Keep the tone factual and report-oriented rather than conversational or promotional.
  4. Explain decisions, workflow, and outcomes clearly enough for evaluators to understand both the project intent and the implementation.
  5. Avoid overly casual wording, marketing language, or first-person singular phrasing.
  6. When useful, frame sections as documentation intended for academic assessment, including objectives, methodology, observations, limitations, and conclusions.
  7. For screenshots, diagrams, and visuals, insert italic placeholders describing exactly what should be added later.
  8. Avoid large code dumps in documentation. Use only short snippets when absolutely necessary.