search

PrimaShouji / Prima2

The Discord bot.
Apache License 2.0
0 stars 4 forks source link

Write detailed software architecture documentation #2

Closed karashiiro closed 3 years ago

karashiiro commented 3 years ago

The bot is very complicated. It would help future development if some proper documentation were written for it.

karashiiro commented 3 years ago

Maybe a separate book-like repository would be good for this. There are static site generators for that sort of thing, like what https://xiv.dev/ uses.

karashiiro commented 3 years ago

Will do this after this school quarter ends, it'll be a lot of work.

karashiiro commented 3 years ago

Can use Google Drawings for the actual diagrams.

karashiiro commented 3 years ago

It also doesn't all need to be done at once, the GitBook can be started and then built out over time.

karashiiro commented 3 years ago

Following something like ICONIX modeling is infeasible for this by myself, but a simple 4+1 is probably acceptable.

karashiiro commented 3 years ago

This should also have a log of infrastructure costs, so I don't forget for transparency purposes.

karashiiro commented 3 years ago

Created at https://github.com/PrimaShouji/documentation with no content.

karashiiro commented 3 years ago

Closing this and moving my monologue to the documentation repo.