• 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Documentation improvements

#11
At my current position we have one Idea that clients (not devs) must get as less as its possible details. Most clients doesn't care of the specifications of the products they get.

With this idea we can think for CI Documentation. New Developers should see that CI is really easy to use Framework. 
I think that we need 2 levels of information in the Documentation::
  • 1st lvl will be main pages (for each Lib/Helper/etc..) - as Library/Form_validation where we will list the base Information about FormValidation class so it can be useful for all new developers or as quick help for anyone who needs to see something. There shouldn't be any too detailed information.
  • 2nd lvl will be detail pages - as Library/Form_validation/Rules , Library/Form_validation/Rules/is_unique - where developers who are aware of CI can see detailed information of behaviour and possible options of the element.. 
Simple for the new devs and Advanced for real usage..
In many cases Docs are the most important presentation of a product.
Best VPS Hosting : Digital Ocean
Reply


Messages In This Thread
Documentation improvements - by RobertSF - 11-09-2014, 05:45 PM
RE: Documentation improvements - by RobertSF - 11-11-2014, 11:54 AM
RE: Documentation improvements - by Chroma - 11-14-2014, 09:30 AM
RE: Documentation improvements - by Narf - 11-17-2014, 04:41 AM
RE: Documentation improvements - by RobertSF - 11-17-2014, 03:21 PM
RE: Documentation improvements - by Narf - 11-18-2014, 02:36 AM
RE: Documentation improvements - by includebeer - 11-17-2014, 07:01 PM
RE: Documentation improvements - by RobertSF - 11-17-2014, 07:03 PM
RE: Documentation improvements - by includebeer - 11-17-2014, 08:28 PM
RE: Documentation improvements - by twpmarketing - 11-18-2014, 03:13 PM
RE: Documentation improvements - by slax0r - 11-18-2014, 01:11 AM
RE: Documentation improvements - by sv3tli0 - 11-18-2014, 03:20 AM
RE: Documentation improvements - by jlp - 12-31-2014, 04:28 PM
RE: Documentation improvements - by RobertSF - 12-31-2014, 05:25 PM

Digg   Delicious   Reddit   Facebook   Twitter   StumbleUpon  


  Theme © 2014 iAndrew  
Powered By MyBB, © 2002-2020 MyBB Group.