Re: Communities

lvirden_at_yahoo.com
Date: 11/20/03 

Date: 20 Nov 2003 13:50:46 GMT

According to Arjen Markus <arjen.markus@wldelft.nl>:
:Last week I asked about the Tcl documentation project, I have not seen any
:replies to that (may have missed them). This seems a good opportunity to ask
:about it again:
:
:* Wiki page <http://wiki.tcl.tk/8948> describes the "user documentation
:project"
:* Who is actively working on the documentation?

The only effort of which I am aware is mentioned on that wiki page - the
tcldocs mailing list.

As far as I am aware, there is no coordinated effort to improve the
documentation - for that matter, I don't recall much more than sporadic
discussions about changes to the docs, primarily centering around the
*roff/html/pdf/xml/sgml/tmml/etc. battles that have occasionally arisen.

:* What parts of the documentation are in desperate need of an update?

I would think that with Tcl frequently touted as a cross platform language,
there should be minimal expectation in the docs that the user will have
access to other 'man pages'.

:* What parts of Tcl are severely underdocumented or not documented at all
: (at least as far as ordinary users are concerned)?

Define 'ordinary user'? Experienced programmer? Novice user? Somewhere
in between?

A novice programmer is going to have a tough time learning to program from
only the Tcl man pages.

:* Is there a need for a user's guide of sorts?

What would you have in mind as a user's guide - an intro to programming in
tcl, or a 'how to use a tcl/tk program', or what? 

-- 
<URL: http://wiki.tcl.tk/ > In God we trust.
Even if explicitly stated to the contrary, nothing in this posting
should be construed as representing my employer's opinions.
<URL: mailto:lvirden@yahoo.com > <URL: http://www.purl.org/NET/lvirden/ >

Relevant Pages

  • Re: Communities
    ... :>:* What parts of the documentation are in desperate need of an update? ... :>: (at least as far as ordinary users are concerned)? ... :> A novice programmer is going to have a tough time learning to program from ... :> only the Tcl man pages. ...
    (comp.lang.tcl)
  • Re: I cant believe how complex this Format SDK is...
    ... I've been a programmer since '80. ... provides me with an unbiased perspective on the docs and APIs. ... Overall I think the documentation is reasonably good, ... run my app in the debugger, such as first-chance exceptions when using ...
    (microsoft.public.windowsmedia.sdk)
  • Re: Language Introductions - what would YOU put into one for Tcl?
    ... and the desire to help the Tcl community. ... weapon language is falling behind in the hype over other hot ... around the excellent (if you are a programmer) HTML docs. ... I'm all for writing a nice intro to Tcl and publishing it in hardcopy ...
    (comp.lang.tcl)
  • Re: Language Introductions - what would YOU put into one for Tcl?
    ... > and the desire to help the Tcl community. ... > weapon language is falling behind in the hype over other hot ... > around the excellent (if you are a programmer) HTML docs. ... > I'm all for writing a nice intro to Tcl and publishing it in hardcopy ...
    (comp.lang.tcl)
  • Re: Q) CCombobox only displays one item.
    ... you specify forms using XAML. ... The documentation is probably being written by the person who is documenting Manifest ... time with a tree view data bound to an internal class, ... because the next thing the programmer needed to do was trivial in MFC ...
    (microsoft.public.vc.mfc)