Design doc formatting!
hey how about some more nerds start arguing about how people word sentances
Document formatting : use LaTeX, let it take care of it (table of contents, of figures, chapters, footnotes, bibliography, index ...) and focus on the content.
Document design (actually dividing in chapters, sections, paragraphs ...) err... no suggestion, really.
Documents [ GDNet | MSDN | STL | OpenGL | Formats | RTFM | Asking Smart Questions ]
C++ Stuff [ MinGW | Loki | SDL | Boost. | STLport | FLTK | ACCU Recommended Books ]
Document design (actually dividing in chapters, sections, paragraphs ...) err... no suggestion, really.
Documents [ GDNet | MSDN | STL | OpenGL | Formats | RTFM | Asking Smart Questions ]
C++ Stuff [ MinGW | Loki | SDL | Boost. | STLport | FLTK | ACCU Recommended Books ]
"Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it." — Brian W. Kernighan
If you really want software engineering industry standards, the IEEE documentation standards might be an idea. The IEEE is main professional body for various kinds of engineers, including software engineers. The ACM might also have some info.
That said, if it''s for your own use, you might be better using your own system - less hassle. As long as it''s reasonably consistent and readable, no one''s going to complain.
That said, if it''s for your own use, you might be better using your own system - less hassle. As long as it''s reasonably consistent and readable, no one''s going to complain.
This topic is closed to new replies.
Advertisement
Popular Topics
Advertisement
Recommended Tutorials
Advertisement