[HN Gopher] Trolltech's Documentation Process
       ___________________________________________________________________
        
       Trolltech's Documentation Process
        
       Author : whatever3
       Score  : 24 points
       Date   : 2024-08-11 19:27 UTC (3 hours ago)
        
 (HTM) web link (rant.gulbrandsen.priv.no)
 (TXT) w3m dump (rant.gulbrandsen.priv.no)
        
       | solarkraft wrote:
       | > Our documentation process worked (we wrote documentation and it
       | largely satisfied the readers)
       | 
       | IIRC this is quite an understatement; Qt documentation is
       | regarded as some of the best in GUI toolkits.
        
         | LorenDB wrote:
         | I mainly work with Qt, so I don't have a ton of experience with
         | other projects' documentation, but I have to wonder if Qt's
         | documentation is some of the best in all of programming.
         | 
         | It certainly has many contenders (cppreference has exhaustive
         | documentation of all things C++), but it's very, very good.
        
           | IshKebab wrote:
           | Yeah it's really among the best. Microsoft's C++
           | documentation in the Visual Studio 6.0 days was also amazing,
           | before they completely ruined it by pushing it all to the web
           | and mixing it up with irrelevant stuff.
           | 
           | Looking through the list of things on devdocs.io the only
           | other thing I can think of that is as good is MDN.
        
         | ghosty141 wrote:
         | Qts doc is good but REALLY lacks in the details. For example
         | how things composit with each other is generally undocumented
         | and the fact that their codebase is quite old and full of
         | techdebt makes that part very annoying for advanced use.
         | 
         | An example: how in QML the Repeater element works inside an
         | ObjectModel.
        
       | firesteelrain wrote:
       | I first used Qt back in 2002-2003 timeframe IIRC. Its
       | documentation was excellent for a burgeoning computer science
       | student. We used Qt in my classes.
        
       | ChrisMarshallNY wrote:
       | I really enjoyed his blog!
       | 
       | On-topic: Documentation is _good_ , and I'm glad someone like him
       | was able to get it going.
       | 
       | We used Qt for internal tools, in my Day Job, but never shipped
       | anything on it.
        
       ___________________________________________________________________
       (page generated 2024-08-11 23:00 UTC)