3

Closed

Project needs user task-focused documentation

description

At present the documentation consists of a few codeproject articles. Those articles are FANTASTIC for a detailed discussion on the entire process from a design and learning perspective BUT for a user looking to get started with RaptorDb, it doesn't allow them to complete certain basic tasks.

For RaptorDb to have greater traction and popularity, the documentation should enable user's to complete their development tasks efficiently (rather than each user piecing together the data across the articles).

Needed:
  • A "quick start" guide on THIS site as an authoritative source, which shows how users can get the library (hopefully over NuGet) and enabled them to with basic operations.
  • Document the API, configuration options and their impact to RaptorDb (perhaps using the Code XML comments?)
To illustrate that using design articles as a substitute for task-oriented documentation = problems, here is an example (no eventual consistency here!):

Latest codeproject article is at http://www.codeproject.com/Articles/375413/RaptorDB-the-Document-Store and shows using rap to perform key operations but nowhere does is specify how to initialize rap. The other codeproject article at http://www.codeproject.com/Articles/190504/RaptorDB DOES initialize it but does so in a manner inconsistent with the WinForms test project source code's
Closed Jan 24, 2015 at 7:09 AM by MGholam

comments

MGholam wrote Jan 23, 2014 at 6:57 AM

Thanks Sid!

I will try and put more time into creating snippets and howtos.

Kristoffer_a wrote Dec 19, 2014 at 12:34 PM

Basic documentation would be for instance:
  • A webpage basic implementation
  • A c# Winforms/WPF basic implementation
  • Setting up RaptorDB as a service or for a webpage
Theese basic steps should be documented in a simple manner with example documentation.
I like your articles that are really in depth, however for basic testing if this is the way to go for me, or for a simple project, I dont want to invent the wheel every time.
A NuGet package would be really great, however some great articles, simple and easy to follow are really what lacks for more people to start using it.

MGholam wrote Jan 24, 2015 at 7:09 AM

Nuget package exists at : https://www.nuget.org/packages/RaptorDB_doc

I have started the documentation... check the getting started page.