https://github.com/jamesread/turtles
A checklist of helpful reminders to document when you come to archiving a project :turtle:
https://github.com/jamesread/turtles
archiving template
Last synced: 21 days ago
JSON representation
A checklist of helpful reminders to document when you come to archiving a project :turtle:
- Host: GitHub
- URL: https://github.com/jamesread/turtles
- Owner: jamesread
- License: cc0-1.0
- Created: 2021-09-10T20:11:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-04T15:13:18.000Z (almost 4 years ago)
- Last Synced: 2025-09-13T10:34:48.138Z (23 days ago)
- Topics: archiving, template
- Homepage:
- Size: 22.5 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The TURTLES checklist :turtle:
The TURTLES checklist is a set of reminders to document when you come to archiving a project. Hopefully, by documenting a bit more at the time of archiving a project, it will serve as helpful context for those people who find (or come back) to the project in the future.
This GitHub repository contains a [markdown TEMPLATE](TEMPLATE.md) that you can use when archiving your own projects.
This approach of creating an archiving checklist was originally described by James Read in [this blog post](https://blog.jread.com/how-to-properly-archive-a-project-48ddbd0208f8). This GitHub repository came afterwards, with a template, as it's a bit more usable for GitHub developers (and easier to contribute) than copying from the blog post.
## Quick high level sneak-peak
- **T — Technologists**: Did enough people contribute to maintaining this project? Developers, Architects, Security, Operations?
- **U — Users**: Did this project have enough active users?
- **R — Requirements**: Was this project still doing what we set out for it to do?
- **T — Technology**: Are there any unsustainable technologies behind this project?
- **L — Learning**: Was anything being learned by maintaining this project?
- **E — Ecosystem**: Is there now an alternative to writing this project?
- **S — Salvage**: Can anything useful be salvaged from this project?
A full [markdown TEMPLATE](TEMPLATE.md) contains many more prompts under this same structure.
## Detailed Example - see the template
[TEMPLATE](TEMPLATE.md)
## Usage
It is hoped that people who have found this useful will add links to their documented TURTLES checklist in the [USAGE](USAGE.md) file.
## Dependencies
The TURTLES checklist is just documentation - it is nothing more than a text file. However, if you want some sort of reference that you are using (or have used) the TURTLES checklist, for example as a reminder to developers, or to activate the GitHub "used by" feature, then you can depend against one of the dummy dependencies - go.mod for Golang, pom.xml for Java/Maven, etc.
This is of course entirely optional.