Home - cse110-sp24-group23/dev-journal GitHub Wiki

What is Noted?

Noted is a streamlined, minimalistic work journal made by and for developers to keep track of their daily progress and accomplishments over time.

Motivation

As developers, we often struggle with keeping track of our personal workflow and find it difficult to recall all our accomplishments when communicating with higher-ups. Therefore, we wanted to create a web app to help developers log their big accomplishments and everyday work.

Functional Overview

Functional Requirements:

  • User must be able to access daily logs where they can update their progress of the day
  • User must be able to log accomplishments, which will populate on a separate page for easy access
  • User must be able to log information separately from the daily progress logs for further reference

Nonfunctional requirements:

Accessibility

  • Must be functional through keyboard interactions
  • Images and Icons must have alternate labels
  • Graceful degradation
  • Visible and maintains responsive design on different devices

Usability

  • Features must be intuitive for developers
  • Any basic feature should be accessible in 3 clicks or fewer
  • Any advanced feature (for example, settings) should be accessible in 5 clicks or fewer

Maintainability

  • Documentation and code comments: Update Wiki regularly, ensure all code follows code styling requirements,
  • Unit tests for all simple functions, integration tests for checking compatibility, and E2E tests for user functionality

Features

  • Navigation bar to easily access different pages
  • Daily log with sections for a structured reflection
  • Calendar with clickable days: clicking on a day takes you to its respective daily log
  • Calendar shows which dates have logs completed and accomplishments associated with them
  • Markdown editing functionality (user can disable it for full keyboard accessibility)
  • Notes page where users can view, add, delete, and edit notes
  • Accomplishments can be logged on the Daily Logs page. They are then populated on the Accomplishments page to have a summary of accomplishments by month, year, or all over time.