home bbs files messages ]

Forums before death by AOL, social media and spammers... "We can't have nice things"

   comp.compilers      Compiler construction, theory, etc. (Mod      2,753 messages   

[   << oldest   |   < older   |   list   |   newer >   |   newest >>   ]

   Message 1,816 of 2,753   
   jgd@cix.compulink.co.uk to Philip Herron   
   Re: Writing Documentation   
   10 Feb 10 16:34:07   
   
   philip@googlemail.com  (Philip Herron) wrote:   
      
   > But I am finding it difficult in what way to document all of this in a   
   > thesis style paper, are there any styles or things to think about when   
   > writing formally about all of this? Should i just write as if its like   
   > a tutorial into everything about my language? Or is there formal ways   
   > of doing this?   
      
   "It depends ...."   
      
   Even in a thesis, it may well be appropriate to start with a brief   
   tutorial to introduce the basic concepts of the language. Then one needs   
   to describe each concept and each construct clearly, although probably   
   in rather less detail than a language standard would.   
      
   For examples, your best bet look at successful published books: the   
   tutorial in _The C programming Language_ by Kernigan & Ritchie is   
   noticeably good and has been imitated several times.   
      
   John   
      
   --- SoupGate-Win32 v1.05   
    * Origin: you cannot sedate... all the things you hate (1:229/2)   

[   << oldest   |   < older   |   list   |   newer >   |   newest >>   ]


(c) 1994,  bbs@darkrealms.ca