[cas-dev] documentation guidelines

[Scott Battaglia]

I'm suggesting that the initial draft take into account documentation
standards that are already in place.  If your suggestion is differing from
the way we do things currently, it may be good to document why (possibly on
a different page).  Just as an example, we don't list explicit changelogs in
files because they're stored in JIRA and in SVN.  We also don't put anything
above the copyright notice.  If you think there's a reason for either of
those, then that's fine, but we should explain why we're changing
procedures.

If you're still in the middle of sorting it out, I apologize for jumping the
gun...it showed up in my Recent Changes feed ;-)

Thanks
-Scott

-Scott Battaglia
PGP Public Key Id: 0x383733AA
LinkedIn: http://www.linkedin.com/in/scottbattaglia


On Thu, Oct 23, 2008 at 11:11 AM, David Whitehurst
<dlwhitehurst at gmail.com>wrote:

> Or do you not see the need to provide guidelines for documentation?
> Not sure your meaning here.
>
> David
>
> On 10/23/08, David Whitehurst <dlwhitehurst at gmail.com> wrote:
> > Scott:
> >
> > You're losing me here.  Am I to remove the note about Steering
> > Committee voting on my guidelines, or ... are you asking me to remind
> > the developers to remain consistent with source code documentation
> > when they move into greater discussion in Confluence?
> >
> > David
> >
> > On 10/23/08, Scott Battaglia <scott.battaglia at gmail.com> wrote:
> > > David,
> > >
> > > Not sure if
> > > http://www.ja-sig.org/wiki/display/CAS/Documentation+Guidelines
> > > is a work in progress, but please be sure to see our current source
> code and
> > > headers when writing up the code documentation.
> > >
> > > http://developer.ja-sig.org/source/
> > >
> > >
> > > -Scott
> > >
> > > -Scott Battaglia
> > > PGP Public Key Id: 0x383733AA
> > > LinkedIn: http://www.linkedin.com/in/scottbattaglia
> > >
> > > _______________________________________________
> > > cas-dev mailing list
> > > cas-dev at tp.its.yale.edu
> > > http://tp.its.yale.edu/mailman/listinfo/cas-dev
> > >
> > >
> >
> _______________________________________________
> cas-dev mailing list
> cas-dev at tp.its.yale.edu
> http://tp.its.yale.edu/mailman/listinfo/cas-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://tp.its.yale.edu/pipermail/cas-dev/attachments/20081023/8e66f894/attachment.html