Effective documentation is crucial for capstone internships in order to keep track of your work and progress, get credit for your contributions, and facilitate onboarding if someone else needs to pick up aspects of the project down the line. Here are some best practices for documentation during a capstone internship:
Use a standardized documentation template/format. Work with your capstone supervisor to agree on what info should be documented for each task or project component. Include essential details like dates worked, tasks completed, any issues encountered, decisions made, resources used, etc. Staying consistent with your documentation format makes the info easy for others to follow.
Store all documentation in a centralized online system. Use a project management, documentation or group collaboration tool your company/organization already uses like Asana, Notion, Sharepoint, Confluence, etc. This allows all relevant parties to access the information from any location. You may keep informal notes separately but the official documentation should be in one centralized place.
Structure documentation like a project plan or report. Break work down into logical sections for each major project component or phase of work. Use descriptive headings and subheadings to structure the information. Consider including an executive summary, introduction, detailed sections for tasks/milestones, a conclusion section, etc. This gives an overall flow and narrative to the documentation.
Supplement documentation with additional files. If useful, attach documents like diagrams, screenshots, data files, photos, or other resources as supporting materials. Clearly name and label attached files so their purpose and content is obvious. Hyperlink or reference attached files within the main documentation for easy retrieval and understanding of context.
Document regularly and thoroughly as work is ongoing. Don’t wait until the end of the internship to compile all documentation. Update records at least weekly and after completing any significant task. Thorough, real-time documentation reduces reliance on recollection later and risk of missing important details.
Solicit feedback and make revisions. Share interim documentation drafts with your capstone supervisor periodically for input and approval. Refine based on their suggestions. Be open to reorganizing content for clarity as the project evolves. Documentation is a living document that should capture the most accurate, up-to-date state of progress and knowledge.
Capture unintended learnings and challenges. Along with planned outcomes, record any unexpected developments, problems encountered, and how they were addressed. Future teams can learn from mistakes or variations from the original project plan. Seeing unexpected hurdles makes the work more understandable and realistic for those who follow.
Include a recommendations section. Based on experiences during the internship, provide recommendations to improve future aspects of the project, process, resources, stakeholders involved, etc. This advice may help build upon initial progress long term.
Consider future needs. Will others use this documentation for training, auditing purposes, or to scale/expand the work? Aim to make the information clear and contextual enough to be useful not just to your immediate supervisor but potentially to new users in the future as well.
Diligent documentation is necessary during capstone projects to comprehensively track individual contributions, share institutional knowledge, and facilitate continuity. With consistency, detail, supplementary materials and consideration of future applications, interns can leave a clear audit trail of successes as well as areas for improvement through well-structured documentation practices. Thorough records are invaluable for maximizing learning outcomes and impact of the internship experience.
Andrew Stroud