Tags:
stale_content1Add my vote for this tag create new tag
, view all tags
See CodevDocumentationProject

Please add comments here about the effectiveness of this process

  • Would be nice to have a plugin to extract the public methods
    • Can build something based on whether the method starts with an underscore (_). * Question as to the usefulness of this - how widely used is that prefix

What should be shown in the listing on CodevDocumentationProject?

  • I am starting to think that just the Module/Script Name plus the Summary fields.
    • Start/Stop include are a bit crap for this. I now need to go back and edit all the topics.
      • Is there a way to query the fields I want?

-- MartinCleaver - 23 Jun 2002 (Randy's comments about Leo moved to TWikiInLeo)

How do you see keeping the documentation that you are developing now in sync with TWiki as it continues to evolve?

  • (It looks like the documentation you're creating will be outside the TWiki codebase, and, for example, not managed by CVS. On the other hand, it looks like you're tackling the documentation at a fairly high level (especially compared to my intent to provide newbie level documentation for Perl and TWiki), and thus, the documentation you create may not need to be revised with every code change.) -- RK

Firstly, keep it at the very high-level. Most of the topics I am wanting people help me create are architectural blueprints - they show how the parts fit together in high-level. I don't want things that unnecessarily duplicate things in the code. -- MC

Secondly, accept that there is some maintenance required but it is not much; after all, how often do we add a new Cgi Script or Dot Pm file to the distribution? -- MC

  • We can tell whether the documentation is being useful, for instance, I think there is benefit to being able to click straight through to the code files. -- MC
  • The topics also benefit in that that people now have names by which they can explicitly refer to and comment on processes and code files by adding comments on the associated comment. -- MC
  • At some point, if people thought there was benefit, there could be value in automatically creating such topics when new files arrived in CVS. This would be beyond the scope of a RendererPlugin though, so would be an Add-on. -- MC

DavidLeBlanc expressed a little bit of interest since then -- he may have some thoughts to add. -- RK

  • Sure, bring them on! -- MC.


Could we use an extra classification for BasicForm's TopicClassification field for all the topics under CodevDocumentationProject and possibly with a ProjectGroup of CodeBaseProject (those topics are very old and use a now defunct set of forms).

-- SamHasler - 15 Feb 2005

Edit | Attach | Watch | Print version | History: r5 < r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r5 - 2008-09-12 - TWikiJanitor
 
  • 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.