Tags:
create new tag
, view all tags
I'd like to see some or more (if I missed it! smile ) internal documentation. I mean a document for programmers new to TWiki that describes the Modules, methods and inter-relationships between them at a broad level of description. Are there existing Perl tools to support creating this kind of thing? POD is at too low a level for this, I think(?). (I've not been using Perl much recently).

Obviously the code is the final authority on what is true, but I'm talking about "seeing the wood for the trees". When a new programmer has a creative suggestion, they will then know where to find the appropriate scaffolding to support it.

BlackHat: Programmers hate writing docs when they'd rather code. It will always get left to someone else to do it.

YellowHat: Making it easier for other programmers to join in and contribute will help the "open source" paradigm of "many eyes make less bugs".

RedHat: Contributing programmers will feel better supported, and more confident that they are working within the intended framework

-- HughSasse - 15 May 2003

I suggest you take a look at CodevDocumentationProject. CoreTeam - that topic is clearly hard to find - how about adding it to the menus at the top here at TWikiDotOrg?

-- MartinCleaver - 16 May 2003

Yes, that's the sort of thing I need. Thank you. Also, how about linking it in to the Menu you get when you start up twiki on a new system, the "Welcome to TWiki" menu which has links to the licence and other docs?

-- HughSasse - 16 May 2003

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r3 - 2003-05-16 - HughSasse
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.