You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Prioritize usage docs over internals because AI code assistants can help newcomers navigate unfamiliar code if given enough context.
Screencasts with closed captions as a faster alternative to written documentation for preservation purposes. (resilience mentions video for promotion, not preservation.)
Software Heritage self-submission check: search the archive by repository URL. If missing, submit via a simple process. preserve mentions Software Heritage as a destination but not how to verify or initiate archiving.
Remove clutter under time pressure: delete unused files, outdated setup instructions, and irrelevant bug reports so that what's useful is easier to find. The workshop only addresses what to add, not what to prune.
Explain why the project stopped in the README. Explicitly state "developer moved on" or "work is unfunded." This is the information users most need but least often find.
Merger as an alternative to shutdown: "When to Do It" asks whether project goals might be better achieved through merger with similar initiatives. The workshop treats shutdown as a given.
Proactive permissions documentation: if no formal sign-off process exists, send an email to someone in authority stating that you believe this is the case, and copy it to an account you'll control after leaving your institution.
Permissions change over time! Don't assume past permission still applies: policies are changing rapidly, and your supervisor may be replaced by someone less sympathetic. Act now.
Negotiate rights at your next employer: ask about their policies and get your right to share your work written into your contract before signing.
Use widely-recognized data formats (CSV, JSON, etc.) over proprietary formts. If data can't be included directly, document URLs with version IDs or download dates.
Submit code to a peer-reviewed venue (JOSS, Journal of Open Research Software, Journal of Statistical Software, etc.)
Do systematic exit interviews for departing team members. Structured conversations covering both explicit and tacit knowledge, distinct from the therapy-style retrospective that comms describes.
Prioritize usage docs over internals because AI code assistants can help newcomers navigate unfamiliar code if given enough context.
Screencasts with closed captions as a faster alternative to written documentation for preservation purposes. (
resiliencementions video for promotion, not preservation.)Software Heritage self-submission check: search the archive by repository URL. If missing, submit via a simple process.
preservementions Software Heritage as a destination but not how to verify or initiate archiving.Remove clutter under time pressure: delete unused files, outdated setup instructions, and irrelevant bug reports so that what's useful is easier to find. The workshop only addresses what to add, not what to prune.
Explain why the project stopped in the README. Explicitly state "developer moved on" or "work is unfunded." This is the information users most need but least often find.
Merger as an alternative to shutdown: "When to Do It" asks whether project goals might be better achieved through merger with similar initiatives. The workshop treats shutdown as a given.
Proactive permissions documentation: if no formal sign-off process exists, send an email to someone in authority stating that you believe this is the case, and copy it to an account you'll control after leaving your institution.
Permissions change over time! Don't assume past permission still applies: policies are changing rapidly, and your supervisor may be replaced by someone less sympathetic. Act now.
Negotiate rights at your next employer: ask about their policies and get your right to share your work written into your contract before signing.
Use widely-recognized data formats (CSV, JSON, etc.) over proprietary formts. If data can't be included directly, document URLs with version IDs or download dates.
Submit code to a peer-reviewed venue (JOSS, Journal of Open Research Software, Journal of Statistical Software, etc.)
Do systematic exit interviews for departing team members. Structured conversations covering both explicit and tacit knowledge, distinct from the therapy-style retrospective that
commsdescribes.