This may be a little off topic. Due to school I only get to attend meetings about twice a year. I am currently taking a course in technical writing and I am trying to make it somewhat interesting. I must create a 20 to 40 page manual. I Decided to tie this into programming by creating a policies and procedure manual for programmers. Since I do not work in shop or environment with multiple programmers I am looking for advice, ideas, and existing or established norms. Some of the things I envision for this document are: coding practices (naming conventions, indentation, fonts? ect.) documentation (bug reports, in code and external ...) development environments (software IDE, machine types, compatibility requirements upgrade procedures) Code development flow (code check out, code review before going live) Request procedures to change or create new code. And anything else you can think of. Make your suggestions as nit picky as you like and include any topic you feel is relevant to the work environment. I have 20 - 40 pages to fill up.
My manual will be tailored to a single shop, but my broader goal is to learn more about how shops in the real world operate, their differences and their similarities. Any help will be greatly appreciated and I would be willing to share the manual with any one interested in it. ----------------------------------------------- To post, send email to [EMAIL PROTECTED] To unsubscribe: Send UNSUBSCRIBE to [EMAIL PROTECTED] To subscribe / unsubscribe: http://www.dfwcfug.org
