Minimum CodePlex project requirements

Feb 23, 2009 at 3:14 PM
There really needs to be some enforcement of minimum requirements around documentation, FAQs and troubleshooting guides for new projects. Otherwise well intentioned projects get created but never completed.
Feb 23, 2009 at 4:16 PM
Agreed, not that members of the documentation choir such as ourselves are likely to have much influence.

Examples:

 -- in ASP.NET MVC RC (release candidate), the RC notes leave out essential information;
    to me there's no excuse because ASP.NET MVC is an important project to Microssoft
    and Microsoft can afford the money to have had a documentation specialist on the
    ASP.NET MVC team from day one of that project.

 -- many developers use Visual Studio 2005 and 2008 which have built in capability
     for documenting as you code, much like the Java world's JavaDoc; sadly,
     this capability is rarely used.

Another pet peeve is that developers do not update comments that need to be updated,
instead, they use the excuse that the comments will get out of date as a reason for
not writing them in the first place.

Another excuse I detest is the claim that the code is self documenting.  It can be
but first the developer must write it so that it is self documenting.

Regards,
Gerry (Lowry)