Documentation Changes

Documentation Review

When I first started working on Novel-It I mapped out the features I want the application to have, and a very sketchy requirements document.

I’ve got to the point now where I have, what I consider, a minimum viable product available in GitHub. It’s no where near all the features I put into the specification. And some of the features that have been implemented deviate somewhat from their feature descriptions.

Part of the process of preparing for a version 1.0.0 is to revisit the features and requirements to see what’s missing from the original Phase 1 development plan, what’s different and why.

To this end I have stopped working on the code (except for bug fixes as the arise) and am now going to concentrate on getting the project documentation right. To facilitate this I have created a new documentation site novel-it-docs. I shall start by transfering the existing feature descriptions into the site and then build out the requirements from there. It’s going to take some time, but it’ll be worth it in terms of the quality of the product moving forwards. I hope you’ll understand why there’s not much being done on the application code side of things while I’m getting the documentation set up.

Meanwhile, you can still read the original Feature Specification and Requirements Specification documents in the project’s docs folder