Serving the Quantitative Finance Community

 
User avatar
FinancialAlex
Posts: 1
Joined: April 11th, 2005, 10:34 pm

Documentation

November 4th, 2011, 10:44 am

QuoteOriginally posted by: outrunI'm experimenting with a pure LaTeX solution now, (on my local machine) and I think that works much better than docbook for me:Also we can convert the LaTeX to html for an online version, xml (and then docbook) and of course to pdf.I would suggest using Lyx, a front-end tool to harness the power of Latex in a very user-friendly way. As for references, we can combine Lyx with JabRef.I am using Lyx + Jabref for my papers and I am quite satisfied with them
 
User avatar
FinancialAlex
Posts: 1
Joined: April 11th, 2005, 10:34 pm

Documentation

November 4th, 2011, 10:51 am

The good news is that Lyx relies on having Miktex installed
 
User avatar
Cuchulainn
Posts: 22937
Joined: July 16th, 2004, 7:38 am

Documentation

November 4th, 2011, 11:07 am

Good stuff. BTW I liked the style of the Sitmo option calculator.I was at the dentist's this morning, so I had time to think about less boring things. These random thoughts entered my head:1. There are different kinds of products(libs, frameworks, systems, test examples/suites, etc.)2. Each product can be documented at several 'levels', depending on the kinds of users (developer, quant, IT. trader).3. Some products can have a standardd doc layout and style; think how NAG libs are documented or GOF/POSA/ACE patterns are documented, UML class and component diagrams. This makes our stuff easier to learn for others.And ISO9126::Usability is most important, agree? Usability - A set of attributes that bear on the effort needed for use, and on the individual assessment of such use, by a stated or implied set of users. Understandability Learnability Operability Attractiveness Usability Compliance Thoughts? //On a separate issue, some doc stuff is already copyrighted which means it cannot be on on an open forum.
Last edited by Cuchulainn on November 3rd, 2011, 11:00 pm, edited 1 time in total.
 
User avatar
Cuchulainn
Posts: 22937
Joined: July 16th, 2004, 7:38 am

Documentation

November 4th, 2011, 11:48 am

Black Scholes documentation according to NAG I think it is a good start, certainly for dedicated libraries.
Last edited by Cuchulainn on November 3rd, 2011, 11:00 pm, edited 1 time in total.
 
User avatar
Cuchulainn
Posts: 22937
Joined: July 16th, 2004, 7:38 am

Documentation

November 4th, 2011, 11:54 am

QuoteOriginally posted by: outrunQuoteOriginally posted by: CuchulainnBlack Scholes documentation according to NAGLooks like a good technical document: lot's of detail, also looks like they have a formal template. Those are the bits I like (I would prefer more plots, colors, especially at the begin part)Indeed, this would be just one document. It is a black box. We also would have white box framework developer, e.g. who create ADE scheme and plug it in. Maybe also worth considering BS in Matlab SDE Toolbox in Matlab
Last edited by Cuchulainn on November 3rd, 2011, 11:00 pm, edited 1 time in total.
 
User avatar
Cuchulainn
Posts: 22937
Joined: July 16th, 2004, 7:38 am

Documentation

November 4th, 2011, 1:04 pm

Another approach with a good mix of text, code and plots. Mathematica docs
Last edited by Cuchulainn on November 3rd, 2011, 11:00 pm, edited 1 time in total.
 
User avatar
Cuchulainn
Posts: 22937
Joined: July 16th, 2004, 7:38 am

Documentation

November 4th, 2011, 1:30 pm

QuoteI was just thinking about NAG, the error test results table is not typically something you need to see in a user manual. If the 'user' is an application developer, then probably yes?