Programming Help

Web Development



What's Here?

  • Members: 149,521
  • Replies: 506,628
  • Topics: 79,833
  • Snippets: 2,666
  • Tutorials: 706
  • Total Online: 1,398
  • Members: 72
  • Guests: 1,326

Welcome to Dream.In.Code
Become an Expert!

Join 149,521 Programmers for FREE! Get instant access to thousands of experts, tutorials, code snippets, and more! There are 1,398 people online right now. Registration is fast and FREE... Join Now!




SE: Program documentation

 
 Reply to this topicStart new topic

SE: Program documentation, essay help
sTromSK
28 May, 2007 - 09:15 AM
Post #1

New D.I.C Head
*

Joined: 28 May, 2007
Posts: 3


My Contributions
hello, I'm writing a school essay about Program Documentation in software engineering. I am doing some research and collecting info about this topic. Ive read a quite good book and found some links but still I don't think its enough thats why I'm posting here. I would like to ask you if you don't know some links or books, where I could find something about this (keywords are software documentation, program documentation).. thank you very much, I appreciate your time.
User is offlineProfile CardPM
+Quote Post

William_Wilson
RE: SE: Program Documentation
28 May, 2007 - 09:22 AM
Post #2

lost in compilation
Group Icon

Joined: 23 Dec, 2005
Posts: 4,101



Thanked: 25 times
Dream Kudos: 3275
Expert In: Java, C, Javascript

My Contributions
QUOTE

I would like to ask you if you dont know some links or books...

no i dont know any links or books.

What exactly are you after? How much to comment? Why comment? How to comment? Where to comment? The more specific you are, the easier it is to get correct help.
User is offlineProfile CardPM
+Quote Post

sTromSK
RE: SE: Program Documentation
28 May, 2007 - 09:29 AM
Post #3

New D.I.C Head
*

Joined: 28 May, 2007
Posts: 3


My Contributions
to be honest i dont know how to be more specific. I just know the subject (program documentation) and that it has to cointain my opinion on Literate Programming.
I think i can write anything about program documentation and how it is used in software enginnering, its pros/cons etc.
User is offlineProfile CardPM
+Quote Post

Amadeus
RE: SE: Program Documentation
28 May, 2007 - 09:48 AM
Post #4

g++ -o drink whiskey.cpp
Group Icon

Joined: 12 Jul, 2002
Posts: 12,349



Thanked: 51 times
Dream Kudos: 25
My Contributions
You'll want to search for articles on the major components of software engineering...analysis documents, design documents, system specification documents, that sort of thing. Test case documents are also very important. I have a good book or two on it, but not electronic, I'm afraid.
User is online!Profile CardPM
+Quote Post

William_Wilson
RE: SE: Program Documentation
28 May, 2007 - 10:56 AM
Post #5

lost in compilation
Group Icon

Joined: 23 Dec, 2005
Posts: 4,101



Thanked: 25 times
Dream Kudos: 3275
Expert In: Java, C, Javascript

My Contributions
Are you looking for more on code documentation within the code, or external documentation, for using methods, classes, etc?

it may be a good idea to talk about the applications such as JavaDoc for java, which uses the comments to generate the documentation, which would affect the way the code is documented, to create the end documentation result.
Perhaps the use of documentation, both within code and externally for using the code would be a good angle to explore.

Also if you discover why coders seem to do little to no documenting in general, i'd love to know.
User is offlineProfile CardPM
+Quote Post

sTromSK
RE: SE: Program Documentation
28 May, 2007 - 11:16 AM
Post #6

New D.I.C Head
*

Joined: 28 May, 2007
Posts: 3


My Contributions
could you pls explain the difference between external and internal documentation ? I dont know how to start and this would be good i think:)

and why do pople write no documentation.. because they write code too fast (in hurry no time for doc), they think "im gonna write doc later", they think "i understand that, why should i write it", young programmers underestimate its importance (they didnt experience reading bad written code with no doc), and its about communication (like every writing) and while programmer is writing it there is nobody who would assess its usefulness or understandability .. :) i think the problem is how to make people realise its importance

This post has been edited by sTromSK: 28 May, 2007 - 11:51 AM
User is offlineProfile CardPM
+Quote Post

Fast ReplyReply to this topicStart new topic
Time is now: 1/7/09 08:27PM
Invision Power Board v2.1.7 © 2009  IPS, Inc.
Licensed to: MediaGroup1

Be Social

Dream.In.Code RSS Feed Dream.In.Code LinkedIn Group Follow Us On Twitter

Live Help!

Tutorials

Programming

Web Development

Reference Sheets

Code Snippets

DIC Chatroom

Bye Bye Ads

Monthly Drawing

Thumb Drive

Top Contributors

Top 10 Kudos This Month