What to Include in Your Software Development SIWES Logbook and Final Report
A software development SIWES placement can expose a Nigerian student to Git, bug fixing, testing, databases, user interfaces and real teamwork. But completing the work is only part of the assignment. You must also show, truthfully and clearly, what you did, what you learned and how your supervisor assessed your progress. A good SIWES logbook records specific daily activities and evidence of learning; a good final report explains the major projects, methods, results and lessons in a structured technical narrative.
For students researching a NITDA internship in Nigeria or a software placement with another technology organisation, the documentation principles are broadly useful. However, the exact cover pages, number of report chapters, logbook layout and submission deadlines depend on your institution and the Industrial Training Fund (ITF) requirements that apply to your programme. The examples below are illustrative, not prewritten entries you should claim as your own.
Understand the difference between the SIWES logbook and final report
The logbook is a dated record of training and workplace activity. It should be updated as work happens and endorsed by the appropriate supervisor. The final report is a considered account of the attachment, showing what the organisation does, which technical assignments you performed, why certain methods were used, and how the experience developed your skills.
The ITF's official student guidance instructs participants to record training activities in their logbooks and complete ITF Form 8. National Open University of Nigeria's SIWES instructions specify daily entries and weekly endorsement by the industry-based supervisor for its students. Federal Polytechnic Offa makes a useful additional distinction: the final report should not merely repeat the logbook chronologically; it should analyse the work and its value.
| Document | Main purpose | Good evidence |
|---|---|---|
| SIWES logbook | Track activities as they occur | Dates, tasks, tools, outcomes, learning and supervisor endorsements |
| Final technical report | Explain experience and technical understanding | Project objectives, workflow, challenges, results and reflection |
| ITF Form 8 | Official end-of-programme assessment documentation where applicable | Completed fields and endorsements under the approved process |
Never replace the official institutional format with a sample found online without checking with your departmental SIWES coordinator.
1. Set up the logbook correctly in your first week
Before recording technical work, fill in the identification details required by your institution's booklet or portal. These can include your name, matriculation number, programme, school, host organisation, unit, dates of attachment and industry-based supervisor. Verify spellings and dates against your acceptance and commencement documents.
Ask whether you must use a physical booklet, an approved online logbook or both. The ITF student portal describes an option for online logbook entries sent to industry-based supervisors for approval, but the required method for your assessment still depends on the applicable ITF and institutional workflow.
Write each entry promptly, ideally at the end of the working day. If no technical task was assigned, state the genuine orientation, meeting, study or observation you completed instead of inventing a coding task. For approved absences or public holidays, follow your institution's attendance notation rules.
2. What every software-development daily entry should include
An effective entry answers five questions: What was assigned? What did I do? Which tools or methods did I use? What was the result? What did I learn or need to follow up? Use the spaces and headings in your official logbook; if they are too small, ask whether an approved supplementary sheet is allowed.
- Date and activity: describe the actual task, not just “worked on the computer.”
- Technical method: mention the relevant tool or process such as Git branches, browser developer tools, SQL queries, API tests or code review.
- Your contribution: distinguish work you performed from a demonstration you watched.
- Outcome: note whether the task was completed, tested, blocked or handed to a supervisor.
- Learning point: record one practical insight or question for the next day.
Specificity makes the logbook useful to a school supervisor and to you. For example, “Investigated a form-validation error, reproduced it with an empty required field and documented the steps for the developer” is stronger than “Learnt HTML and JavaScript,” provided it describes what actually occurred.
3. Illustrative five-day SIWES logbook sample for a software trainee
The following example imagines a student assigned to a small internal appointment-booking prototype. It is not an account of a real student, NITDA placement or employer project. Adapt the level of detail and the date format to your institution's official booklet, and write only activities you actually completed.
| Day | Illustrative logbook entry | Learning or outcome |
|---|---|---|
| Monday | Attended development-team orientation; reviewed project requirements, repository structure and Git branch workflow with my supervisor. | Understood task tracking and the difference between a feature branch and the main branch. |
| Tuesday | Built a responsive appointment form in a training environment using HTML, CSS and JavaScript under supervision. | Practised accessible labels and required-field validation. |
| Wednesday | Tested the form with missing, valid and malformed input; recorded three reproducible UI issues in a sample bug tracker. | Learnt to distinguish expected behaviour from actual results. |
| Thursday | Updated client-side validation in an isolated branch and submitted the change for review; corrected feedback about error messages. | Practised version control, code review and clear user feedback. |
| Friday | Demonstrated the revised prototype to my supervisor; documented completed tests and outstanding tasks. | Improved testing documentation and technical presentation. |
The weekly summary could state that the focus was introductory front-end development and quality assurance, with a pending next step to learn how the application sends data to an API. Where your logbook requires a supervisor's remarks, signature, date or stamp, leave those fields for the authorised person; never sign on their behalf.
For wider career context, FlyingEze has reported on NITDA's emphasis on practical digital skills for Nigeria's economic growth . A truthful logbook can help students identify which of those employable skills they actually developed during their placement.
4. Reflect the actual software development lifecycle
Software work is not only programming. Your logbook may legitimately document requirements discussions, sketches, database planning, troubleshooting, deployment observations, documentation and testing. The important issue is your actual level of involvement.
| Work area | Useful details to record |
|---|---|
| Requirements | Problem statement, user needs, acceptance criteria and clarifications received |
| UI/UX | Wireframes, responsiveness, accessibility checks and feedback |
| Backend/API | Endpoint behaviour, request validation, sample responses and error handling |
| Database | Schema concepts, sample queries and test-data management |
| Version control | Branching, commits, pull requests and code-review lessons |
| Testing | Test cases, defects, fixes and regression checks |
| Operations | Supervised build or deployment observations and documentation |
Do not exaggerate an observation into full responsibility. “Observed the deployment checklist and discussed rollback planning” is accurate if your supervisor demonstrated it; “deployed the production system” is not, unless you genuinely performed that authorised task.
5. Get weekly feedback and supervisor endorsements
Set a regular time for your supervisor to read and endorse the logbook. The Federal Polytechnic Offa guidance calls for weekly industry-supervisor endorsement; Rivers State University similarly describes daily/weekly records, weekly industry review and institution monitoring. ITF's employer guidance describes the appointment of an industry-based supervisor and approval of students' logbooks.
Before each review, check that dates are continuous, wording is legible, activities are truthful and incomplete tasks are not described as finished. Ask the supervisor what you can improve next week. If the supervisor is unavailable for an extended period, inform the school's SIWES coordinator promptly instead of waiting until the end of the attachment to seek missing signatures.
Employer and university supervision arrangements vary; some institutions may have additional inspection dates, electronic approval or specific record-keeping requirements.
6. Protect confidential code and customer information
A technical report should show evidence of learning without exposing business secrets. Do not paste private source code, API keys, database passwords, unpublished customer records or identifiable screenshots into a logbook, public portfolio or submitted appendix without permission.
Use a generalised description when necessary: “Tested role-based access on a sample user account” communicates the skill without naming customers or revealing infrastructure details. Create synthetic test data, redact identifying information and ask your supervisor what material can be included in academic submissions. Even a screenshot that appears harmless may reveal internal URLs, account names or tokens.
A supervised exercise conducted on a development server should not be described as a security assessment of a public production system. Avoid publishing material that belongs to the employer, even when you contributed to it.
7. Plan the SIWES final report as an explanation, not a diary
Use the report template issued by your institution where one exists. As a general model, Federal Polytechnic Offa identifies a front cover, table of contents, certification, acknowledgement, introduction, main body, conclusion and recommendations, and an appendix. Schools may add an abstract, declaration, dedication, list of figures, references or oral defence requirements.
A practical software development final report can follow this structure:
| Section | Suggested content |
|---|---|
| Preliminary pages | Title page, required certification/declaration, acknowledgement, abstract if requested, contents and figures |
| Chapter 1: Introduction | SIWES purpose, training objectives, duration and your expectations |
| Chapter 2: Host organisation | Approved description of employer, department, team structure and work environment |
| Chapter 3: Technical work | Projects or tasks, problem statements, technology choices, design and testing process |
| Chapter 4: Results and learning | Outputs, lessons, problems encountered, solutions and limitations |
| Chapter 5: Conclusion | Overall achievements, skills gained and evidence-based recommendations |
| References and appendices | Materials cited and approved diagrams, sample outputs or evidence |
Chapter numbers and formatting are a suggested teaching outline, not a national standard. Follow the specific departmental instructions for page layout, citation style and report length.
8. Explain one technical project clearly in the main report
Choose a project or workstream where you can honestly explain the process. The strongest discussion follows a simple logic: problem → objective → your role → methods → tests → results → limitations. You do not need to pretend you designed the whole application to show valuable learning.
For an illustrative student appointment-form project, the account might explain that users needed clearer validation messages when required details were omitted. The student observed the existing interface, reviewed acceptance criteria with a mentor, added accessible field messages in a test branch and tested empty and malformed input. After peer review, the student revised the wording and documented the remaining work. No claim of production deployment is necessary.
In the report, support these statements with a permitted form diagram, anonymised test table or screenshot from a training environment. Show where your responsibility started and ended. If a task was unfinished, say so and explain what prevented completion.
9. Use diagrams and appendices only when they add evidence
Software-development reports can benefit from simple flowcharts, entity-relationship diagrams, API request/response examples, annotated interface views and test-result tables. Label figures and refer to them in the text rather than adding uncaptioned screenshots to increase page count.
For example, a flowchart might illustrate how an appointment request is checked before submission. A small test table could show input, expected output, actual output and pass/fail status. Clearly mark hypothetical or synthetic examples as such. Never include actual customer records or confidential deployment diagrams merely to make a report look sophisticated.
Use references for concepts or diagrams adapted from books, vendor documentation or official technical guides. Cite any permitted organisational materials according to your school's policy.
10. Complete SCAF, Form 8 and other submission requirements separately
The logbook and final technical report are not substitutes for administrative forms. ITF's student guidance names the Students Commencement Attachment Form (SCAF) and the end-of-programme ITF Form 8. Its resources page lists the documents and a logbook sample. The University of Ibadan's industrial-training centre explains that Form 8 involves the student, employer and institution and may have funding-specific applicability.
Ask your department which forms are required for your programme, who fills each part, where they must be submitted, and by what deadline. National Open University of Nigeria, for example, publishes its own additional reporting and employer-evaluation workflow, which should not be assumed to apply identically at every university or polytechnic.
Keep records of approved submissions and endorsements. If an official process requests banking information, provide it only through your institution's or ITF's authenticated channel, not a third-party logbook writer or unofficial placement agent.
11. Check the report against the logbook before submission
Do a consistency review. The dates of training, department, projects and stated responsibilities in the final report should agree with your logbook and supervisor's assessment. If a project took three weeks, the report should not suggest it was completed in one day. Conversely, a major assignment discussed in the report should generally be traceable to genuine training records.
Confirm all required signatures, spelling of names, figure numbering, sources, approved screenshots and institutional formatting. Review the PDF or printed copy before submission to ensure tables and images are readable and that hidden comments or private information have not slipped into the file.
Remember that your school may require a physical defence or a presentation. Prepare to explain the skills shown in your report, the challenge you encountered and what you would improve—not merely recite programming-language definitions.
Example SIWES logbook and final report checklist
| Before you submit | Check |
|---|---|
| Every actual training day is recorded as required | Dates and activities agree with attendance |
| Each significant task has a clear description | Your contribution, outcome and learning are evident |
| Supervisor endorsement is complete | Required signatures/online approvals and institutional reviews obtained |
| Administrative forms are complete | SCAF, Form 8 and school-specific documents handled as applicable |
| Final report follows the department's template | Required sections, citations, formatting and deadlines met |
| Project evidence is permitted and safe | No exposed credentials, sensitive customer data or unapproved company code |
| Report matches the logbook | Dates, responsibilities and achievements are consistent |
Frequently asked questions
Should I write my software development SIWES logbook every day?
Regular daily entries are the safest approach and are expressly required by some institutional guidance. Follow your school's approved form and have the industry-based supervisor endorse the entries at the required frequency, commonly weekly.
Can I write about tutorials and observation instead of coding?
Yes, when those were legitimate assigned training activities. Say what you studied or observed, how it relates to the workplace and what you learned. Do not invent code contributions or pretend training exercises were production features.
Do I need to include full source code in my SIWES final report?
Usually a full codebase is unnecessary. Use approved explanations, pseudocode, selected permitted snippets or diagrams, subject to your institution's requirements and employer confidentiality rules. Never copy private repositories without authorisation.
Is ITF Form 8 the same as the final technical report?
No. Form 8 is an official end-of-programme assessment document where applicable; the technical report explains the student's work and learning. Confirm both with your institution.
Is the SIWES logbook different for NITDA placements?
The governing documentation still depends on ITF and your institution. NITDA acknowledges working with industrial-training students, but its published innovation materials do not establish a special universal NITDA logbook template or a currently open SIWES intake. Verify host-specific instructions directly.
Can I use AI to write my SIWES report?
Use writing tools to improve structure and grammar only within your institution's rules. You remain responsible for truthful activity records, accurate technical explanations, citation and confidentiality. Do not submit AI-invented tasks or fabricated supervisor evaluations.
Final takeaway
A strong software development SIWES logbook tells the truth about what happened each working day; the final report tells the reader why the work mattered and what you learned. Keep dated records, request supervisor feedback, organise technical projects into clear explanations and verify that every formal document follows your institution's instructions.
Whether your industrial training takes place at a private software company, university ICT unit or a public technology organisation, the best evidence of achievement is specific, honest, well-supervised work—not an impressive-looking report copied from somebody else's placement.