Create a product team handbook/runbook

cisagov / manage.get.gov

A Django-based domain name registrar used by the .gov domain to communicate with an EPP registry

https://get.gov

Other

57 stars 17 forks source link

Open vickyszuchin opened 6 months ago

vickyszuchin commented 6 months ago

Create a knowledge wiki to centralize information like:

Considerations:

Explored pros/cons of wiki tool vs what we have
it is sometimes done to just put a link to a Markdown file in the repo on a wiki page.
Perhaps a good in-between is to have the Wiki that connects everything (like a site map)

No response

No response

vickyszuchin commented 6 months ago

Action item from engineering huddle from 2/12.

h-m-f-t commented 5 months ago

I'm unsure a wiki is the right form for this, but we can certainly create better documentation in the form of a handbook or runbook.

vickyszuchin commented 5 months ago

Accepted into the backlog. Good to have for new hire onboarding.

vickyszuchin commented 5 months ago

Suggestion: have a meeting to decide on format and content for handbook.

kristinacyin commented 5 months ago

Wanted to share TTS's handbook since I think it's a good example - it's been super helpful for me to reference! https://handbook.tts.gsa.gov/ https://github.com/18F/handbook

vickyszuchin commented 5 months ago