Developer Documentation
RIF Architecture
General Developer Documentation
To-do Lists and Roadmaps
Consolidated
I’ve put together a partial consolidated to-do list based on what is still useful from the documents below. It still requires work, specifically discussion with the rest of the team. And the various points will then be extracted and turned into Issues on GitHub.
Still Valid or Useful
These contain at least potentially useful information.
- RIF to-do List (Last changed March 2018) – This has the most useful details of any of these files. Some things are genuinely still to be done. Some are done and marked as such. Some are done and not marked.
- Node Services TODO (Last changed October 2017) – Some things here are probably still valid. Need to discuss with Peter.
Obsolete
These documents are largely outdated, though they have some information about the history of the project and hints for future improvements.
- RIF Re-development – This is a high-level overview, and out of date; though it does include some notes that explain some of the original plans.
- Kev’s Suggested Road Map with the Middleware – Some OK suggestions here, notably about reworking the web services and creating an ICD-9 service. Also tells us the name of the main class in the data loader.
- Middleware Code Road Map – Parts of this provide a decent overview of the project structure within the RIF. It’s out of date regarding the package structure and the way the database-related classes are split up, but it has some value. Ignore the coding conventions, though.
- Middleware Handover Notes – This is essentially all out of date. The notes on the taxonomy services might be useful.