Skip to content

Daily Development Log Template

Daily Log Documentation Template

About the Logbook

Context:

  • The team is divided into working groups, each with its own general objectives.
  • Each workday, the team sets specific objectives, which must be reported in the logbook.

Where to write: Discord

  • The logbook is kept on Discord, in a forum for each working group.
  • Each general objective has its own thread within the forum. The first message in the thread should define the general objective.
  • Progress is reported by adding messages to the thread, with updates as they happen. The messages can be text, audio, photos, links, or other types of media.

Expected content

The following content must be generated for each general objective that is worked on during the day.

Objectives of the day

  • < what I am going to start and finish doing today >
  • < participants of the day >

A list of what you plan to accomplish that day, and a list of people who will work on it.

This does not include general objectives (the general objective is defined in the thread description).

These goals for the day should be small and deliverable, very short-term, answering the question: What exactly do I want to accomplish in the next two hours?

Results

  • < what I did today >
  • < photos, links, difficulties encountered, write down everything relevant >
  • < documentation generated in the wiki (if applicable) >

Before ending the day, write a summary of the results, very to the point.

Mandatory contents:

  • Text explaining what was achieved, what was finished and what was missing with respect to the day's objectives.
  • Links to the results if there were any (CAD files, scripts, diagrams, etc.).
  • Photos, screenshots, links, and other content to explain.

When we have to write on the wiki we will often need those photos to explain procedures or support ideas.

Next steps

  • < what I will do tomorrow >

What's next after what I did today? Are both things articulated with each other?

Content:

  • Task list to continue with the goal

Example

exampledailylogdoctemp.png

Generate documentation

Documentation for each objective is generated from the results accumulated in the corresponding Discord thread.

To generate this documentation, you must have written your results in Discord threads on a daily basis.

Every 10-15 days, a consolidated version of the accumulated results is documented in the Wiki. This documentation must include the key points listed in the "Technical Documentation Template" spreadsheet uploaded to Drive.

Each type of objective will have some key points that must be included in the documentation, and others that are optional or secondary. This should be determined based on the type of objective results (e.g., instructions, CAD files) and the audience for the documentation (e.g., users, manufacturers).

Every 10 days, one can upload all of the results to the documentation categories until all of the relevant items are completed.

Information available here