How to Write Your Project Report: Chapters, Diagrams and References
Write your BE or BSc CSIT project report in the right order: chapters, numbered figures and tables, testing results, limitations and properly cited references.
On this page
Most students leave the report until the last two weeks, and it shows. Missing test results, blurry screenshots, references copied as bare links, and a conclusion that does not match the objectives. The report is the permanent record of your project. Panels read it, supervisors sign it, and future students borrow it from the library.
This guide explains the chapters most engineering and computer science project reports contain, what goes in each one, how to handle figures and tables, and how to cite datasheets and papers properly.
Before anything else: your college or department almost certainly has a report template, with rules for margins, fonts, page numbering, front pages and binding. Check your department's format and follow it exactly. Where it differs from this guide, the template wins.
Write the report while you build
The single best habit is to write a little every week. Keep a project log (a document or notebook) with the date, what you did, what failed, photos and screenshots. When report time comes, most of your methodology and implementation chapters are already drafted from the log.
Also start a reference list on day one. Every time you read a paper, datasheet or documentation page you use, add it to the list right away. Searching for "that website I saw in month two" is painful.
Typical report structure
Here is a common order. Your template may rename, merge or reorder these, so treat it as a map, not a rule.
Scroll sideways to see all columns.
| Part | What it contains |
|---|---|
| Front matter | Title page, certificate or approval pages, acknowledgement, abstract, table of contents, list of figures, list of tables, list of abbreviations |
| Chapter 1: Introduction | Background, problem statement, objectives, scope and limitations |
| Chapter 2: Literature review | Related work, comparison table, the gap your project fills |
| Chapter 3: Methodology | Block diagram or system architecture, design, tools, development model |
| Chapter 4: Implementation | Hardware build, circuit, code structure, database, user interface |
| Chapter 5: Testing and results | Test cases, measurements, result tables and charts, discussion |
| Chapter 6: Conclusion | Summary, limitations, future work |
| References | Every source cited in the text |
| Appendices | Full code listings, datasheet extracts, extra screenshots, user manual |
Engineering hardware projects often put more weight on circuit design and measurement. CSIT projects often include requirement analysis, feasibility, and diagrams such as use case, ER, DFD or class diagrams. Your supervisor will tell you which diagrams your department expects.
What goes in each chapter
Abstract
One paragraph, usually written last. Problem, what you built, how you tested it, and the main result. No citations, no figures. Someone should understand your project from the abstract alone.
Introduction
Reuse and improve your proposal: background, problem statement, objectives and scope. Your objectives here must match the ones you test in Chapter 5. If they changed during the project, update them honestly (and discuss the change with your supervisor).
Literature review
Expand the comparison table from your proposal. For each related work, describe the method, result and limitation in your own words, then explain the gap. Do not paste abstracts. Many colleges check reports for similarity, so follow your college's academic integrity policy, write in your own words, and cite whatever you use.
Methodology
This chapter explains how you designed the system. Include the block diagram, flowchart or architecture diagram, the reasons for your component or technology choices, and the development approach. A good test: could another student rebuild your project from this chapter?
Implementation
Show what you actually built. For hardware, the circuit diagram, a connection table, photos of the build and the important parts of the code. For software, module structure, screenshots of key screens, database design and the core algorithm. Put long code listings in the appendix and keep only the important parts in the chapter, with an explanation.
Testing and results
This is where many reports are weakest. Every objective should have at least one test, and each test should have a result.
Scroll sideways to see all columns.
| Test ID | Objective tested | Method | Expected | Actual | Pass? |
|---|---|---|---|---|---|
| T1 | Measure tank level | Compare reading with tape measure at 5 depths | Close to the tape value | Write your measured values | Yes/No |
| T2 | Show level on phone | Open page on phone on the same Wi-Fi | Page loads with level % | Write what happened | Yes/No |
| T3 | Handle sensor fault | Unplug sensor while running | Shows "sensor error" | Write what happened | Yes/No |
Fill this with your real measurements, including the ones that did not go well. Then discuss the results: why some readings were off, what affected accuracy, and what you changed.
Conclusion, limitations and future work
Summarise what you achieved against each objective. State the limitations plainly. Then list realistic future work. This chapter should be consistent with what you say in the viva.
Diagrams, figures and tables
Good figures make a report easy to read. A few rules most templates share:
- Number every figure and table by chapter: Figure 3.1, Figure 3.2, Table 5.1.
- Captions: commonly placed below figures and above tables, but follow your template.
- Refer to every figure in the text: "The block diagram is shown in Figure 3.1." A figure nobody mentions should not be there.
- Draw your own diagrams with a tool such as draw.io, a CAD or circuit tool, or a clean hand drawing scanned properly. If you reuse someone else's figure, cite it in the caption.
- Screenshots: crop to the useful part, keep text readable, and avoid phone photos of a laptop screen.
- Circuit diagrams: label pin numbers and component values. A wiring photo is not a circuit diagram.
References: cite properly
"Copy-paste links" are not references. A proper reference lets a reader find the exact source.
Pick one style and stay consistent
Engineering departments often use IEEE style (numbered references like [1], [2]), while some departments use APA or Harvard (author and year in the text). Use the style your college asks for, and use it everywhere.
What to cite
- Papers and books for theory, related work and methods.
- Datasheets for every specification you quote. If you write that a sensor works from 3.3 V to 5 V, or that a regulator needs a certain input voltage, the manufacturer's datasheet is the source.
- Official documentation for libraries, frameworks and APIs you used.
- Any figure, table or code you did not create yourself.
Example (IEEE-style pattern)
The pattern for a datasheet is roughly: manufacturer, "title of the document", document type, year or revision. For a web page: author or organisation, "page title", site name, URL, and the date you accessed it. Check your template for the exact punctuation.
Tools that help
Reference managers such as Zotero or Mendeley, or the built-in citation tools in your word processor, keep numbering correct when you add or move references. Learn one early, not the night before submission.
Common report mistakes
Scroll sideways to see all columns.
| Mistake | Fix |
|---|---|
| Objectives in Chapter 1 do not match the tests in Chapter 5 | Map each objective to a test case |
| Results say "it works" with no numbers | Add a test table with real measurements |
| Figures without numbers or captions | Number by chapter and refer to each in the text |
| Bare URLs as references | Use the full reference style your college asks for |
| Whole code pasted in the chapter | Explain key parts; put full listings in the appendix |
| Conclusion claims features never tested | Claim only what Chapter 5 shows |
| Template rules ignored | Re-read your department's format before printing |
FAQ
How long should the report be?
There is no universal length. Your department may set a page range. Focus on complete chapters and real results rather than page count.
Can I use a report from a senior as a template?
Looking at an approved senior report is a good way to understand your college's style. Never copy its content. Write your own text and cite any source you use.
Where do datasheets go, in the references or the appendix?
Cite the datasheet in your references wherever you quote a specification. If your department allows it, a short extract can go in an appendix, but the full datasheet usually does not need to be printed.
Do I need to include all my code?
Usually the important parts go in the implementation chapter, and full listings (or a link to a repository, if your college allows) go in the appendix. Check your department's format.
How do I plan the whole project timeline so the report is not rushed?
See How to Choose and Plan Your Final Year Project. If you are still searching for an idea, browse machine learning project ideas or BSc CSIT project ideas with tech stacks.