Name of the project

Version Date Notes By
0.2 2020-04-02 Renamed section "Jobs" to "Scheduled jobs" FPA
0.1 2020-03-25 Initial release JFM

Description

This section should describe the objective and the main features of the project.

You should include topics like:

  • Main features
  • Architecture
  • Special needs

Documentation

List all documentation available of the project.

Changes to the original requirements

2020-02-01

Description of the changes.

This can be a total description of what was changed or information on where to get that information. Things like documentation, emails, etc...

2020-01-01

Changes must be in descendant order.

Integration

Describe all the integrations that the software may have, including as much information as possible.

  • Name of the credentials on bitwarden
  • What was implemented for the integration
  • Dependencies
  • Repository of the package if available
  • Link to the documentation of the integration, both client and server
  • Contacts

Scheduled jobs

Specify which scheduled jobs are available for this project, what they do and what needs to be done in case there's the need to run them manually.

Update

Include information on how to update the project.

Others

Include any other information that is relevant that don't fit in any of the sections above.

Things like:

  • Special software configurations
  • Tricks and hacks
  • Things not working as they should
  • Helper scripts