# projects · projects.md
SE Documentation
SRS, design docs and technical reports written to the standard your course grades against.
Software engineering documentation is graded on traceability as much as content — a requirement mentioned once and never referenced again in the design reads as a gap. We build the diagrams properly rather than sketching them, and trace every requirement through so the document reads as one coherent argument, not a stitched-together checklist.
What you get
- Structured to the exact template your course specifies (SRS, design doc, etc.)
- Requirements traced through to the design, not just listed once
- Diagrams built properly — UML, ERD, sequence — not sketched
- Written in the tense and voice your course style guide expects
- Consistent terminology throughout, checked against your own glossary
- Proofread for the kind of ambiguity a marker will flag
What to send first
- The project proposal or approved title, and the module handbook
- Milestone and supervisor-meeting dates
- Required documents: SRS, design, test plan, final report, poster
- Any feedback your supervisor has already given
How it runs
- 01
Send the spec
The brief, the rubric, any starter code and the versions your marker uses. A photo of the PDF is fine to begin with.
- 02
Scope and quote in writing
We read it properly, ask what is unclear, and confirm a fixed price and delivery date. A small advance confirms the order.
- 03
Build against the brief
Work is tracked task by task against the spec. Longer projects are split into milestones you can review as they land.
- 04
Tested handover
A repo that installs from a README, run against your test cases, with the write-up if your rubric asks for one.
- 05
Fixes and walkthrough
One round of fixes if a marker flags something, and a walkthrough of how it works so you can explain it.
SE Documentation: common questions
For capstones that is the default: proposal, design, build and report are delivered in stages that line up with your supervisor meetings, so feedback lands before the next stage.
Yes — SRS, UML and design documents, test plans and the final report, written to match the code that was actually built.
It depends on the scope of the brief, the stack and the deadline. Send the spec on WhatsApp and you get a fixed price and delivery date in writing before any work starts — no hourly meter.
Turnaround depends on scope and is agreed with the quote. Tell us the real deadline, including the timezone, and we will say honestly whether it is workable before you commit.
// related
Often paired with se documentation
./send-brief
Send your template.
Paste the se documentation brief into WhatsApp — the message already names the service. Scope and price come back in writing.