[Feedhenry-raincatcher] Raincatcher feedback from a newbie

[paul wright]

+1

Overview of Module = outline of purpose, limitations/restrictions?
Do we need   Setup, Troubleshooting sections?

Paul

On 26/01/17 14:35, Tom Jackman wrote:
> Hi Summers,
>
> I definitely feel we need a lot of work done in the docs side of 
> things alright. We should be aiming to have each module's README to be 
> like any cordova plugins readme file.
>
> It would probably be a good idea to have the same README template for 
> each module too so people know where to look for information no matter 
> what module's repo they are on. Some headings could be:
>
>   * Overview of Module
>   * Module Type (Client/ Client & Cloud etc)
>   * API
>   * Code Examples for each Function
>   * Integrating into a larger solution
>   * Upgrade Notes
>   * etc etc
>
>
> Similarly to the RHMAP help documentation, I think we missed a trick 
> by not having a section on what the different functions inside of the 
> Raincatcher sample solution actually are in the actual docs for 
> developers. It jumps straight into the nitty gritty, without pointing 
> out the basics of what it actually does. [1]
>
> [1] https://github.com/feedhenry-raincatcher/raincatcher-documentation
>
> -- 
>
> Red Hat <http://www.redhat.com/>
>
> Tom Jackman / Associate Software Engineer
> tjackman at redhat.com <mailto:tjackman at redhat.com> / 0894751360
>
> /Slack/- @tjackman #rhmap #rhmap-rmad
>
> Red Hat
> Waterford, Ireland.
> www.redhat.com <http://www.redhat.com/>
>
>
>
> _______________________________________________
> Feedhenry-raincatcher mailing list
> Feedhenry-raincatcher at redhat.com
> https://www.redhat.com/mailman/listinfo/feedhenry-raincatcher

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/feedhenry-raincatcher/attachments/20170126/08fe8c64/attachment.htm>