user docs for now, tech docs later, documentation tools to use
Erik Jones <[email protected]> Wed, 6 Oct 2004 18:35:23 -0700 (PDT)
| Newsgroups | gmane.comp.audio.zinf.devel |
|---|---|
| Message-ID | <[email protected]> |
--0-1533987673-1097112923=:75783 Content-Type: text/plain; charset=us-ascii Zinf Team, Im very pleased to hear that I would be welcomed to help the project. My present thoughts are that I would like to start with User Documentation. When I have completed a decent amount of documentation and have gotten to know the source a bit I would happily begin Technical documentation assuming everyone was pleased with my previous work. My present idea is that I need to do some research into what types of formats are used in the community and what tools I should use. The user documentation will help me develop a style and some basic proficiency with the tools and then I can tackle the technical challenge of the tech docs. I believe the tech docs will be more educational for me, but the user docs will likely get more use so it is a worth while trade all in all I think. Thanks for your time again guys, I will post again when I have some ideas. Feel free to post any suggestions. For example, what type of User docs would be good? I was thinking: 1) General Usage 2) Useful features 3) Trouble Shooting Common Installation Issues 4) Compiling Zinf for your sytem On sourceforge.net I am fluidic-binary http://sourceforge.net/users/fluidic-binary/ I am presently looking at things such as DocBook: http://opensource.bureau-cornavin.com/crash-course/ I think DocBook might be good for general documentation, but Im not sure if it is the best tool for the job right now. I am also looking at Doxy,gen for tech docs: http://www.stack.nl/~dimitri/doxygen/index.html Especially since I saw it on the zinf webpage. --------------------------------- Do you Yahoo!? vote.yahoo.com - Register online to vote today! --0-1533987673-1097112923=:75783 Content-Type: text/html; charset=us-ascii <DIV> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>Zinf Team,</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" /><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>Im very pleased to hear that I would be welcomed to help the project.</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>My present thoughts are that I would like to start with User Documentation. When I have completed a decent amount of documentation and have gotten to know the source a bit I would happily begin Technical documentation assuming everyone was pleased with my previous work.</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>My present idea is that I need to do some research into what types of formats are used in the community and what tools I should use. The user documentation will help me develop a style and some basic proficiency with the tools and then I can tackle the technical challenge of the tech docs. I believe the tech docs will be more educational for me, but the user docs will likely get more use so it is a worth while trade all in all I think.</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>Thanks for your time again guys, I will post again when I have some ideas.</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>Feel free to post any suggestions. </FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>For example, what type of User docs would be good? </FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>I was thinking:</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>1) General Usage</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>2) Useful features</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>3) Trouble Shooting Common Installation Issues</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>4) Compiling Zinf for your sytem</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>On sourceforge.net I am fluidic-binary</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><A href="http://sourceforge.net/users/fluidic-binary/"><FONT face="Times New Roman" size=3>http://sourceforge.net/users/fluidic-binary/</FONT></A></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>I am presently looking at things such as DocBook:<BR></FONT><A href="http://opensource.bureau-cornavin.com/crash-course/"><FONT face="Times New Roman" size=3>http://opensource.bureau-cornavin.com/crash-course/</FONT></A></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>I think DocBook might be good for general documentation, but Im not sure if it is the best tool for the job right now.</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT face="Times New Roman" size=3>I am also looking at Doxy,gen for tech docs:</FONT></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><A href="http://www.stack.nl/~dimitri/doxygen/index.html"><FONT face="Times New Roman" size=3>http://www.stack.nl/~dimitri/doxygen/index.html</FONT></A></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><o:p><FONT face="Times New Roman" size=3> </FONT></o:p></P> <P class=MsoNormal style="MARGIN: 0in 0in 0pt"><FONT size=3><FONT face="Times New Roman">Especially since I saw it on the zinf webpage.<o:p></o:p></FONT></FONT></P></DIV><p> <hr size=1>Do you Yahoo!?<br><a href="http://vote.yahoo.com">vote.yahoo.com</a> - Register online to vote today! --0-1533987673-1097112923=:75783-- ------------------------------------------------------- This SF.net email is sponsored by: IT Product Guide on ITManagersJournal Use IT products in your business? Tell us what you think of them. Give us Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more http://productguide.itmanagersjournal.com/guidepromo.tmpl