: Re: Documenting framework features and descriptions We have written a custom software framework and it has grown to the point where we are ready for documentation. This documentation will be used

Personally I use Latex, more specifically pdflatex, which is free to download. It is text-based, learning it will probably take a week or two, but there are online examples and help through StackExchange.

The advantage is you can produce charts, diagrams, flowcharts and anything else you want (art for example) using other packages, in their own PDF files, and then "include" them in your documentation.

For myself, as a research scientist, some of my graphs can be complex and we use special packages to produce them, and not always the same packages. I might produce a few with just a spreadsheet, and some diagrams with Draw, and others with a specialty package designed to draw, say, molecular diagrams, or engineering diagrams.

Latex itself is the best way (by far IMO) to render complex mathematical equations, and to back-reference in the text or build a bibliography.

In technical fields (STEM) at least I think this is the package most used in academia and research, in the four universities I have attended or worked at, it is difficult to finish a PhD in a STEM field without being versed in Latex.

Load Full (0)

: Creating a persona for cross niche marketing Not strictly a writing question but this touches on some issues that some writers may face, and I thought maybe someone here may be able to help.

@Gonzalez219

Load Full 1 Comments

: Writing a book in a non native language I have a fantasy story in my head for several years now. I wrote an outline for a book and draw a crude map of the world. I even started writing

@Gonzalez219

Load Full 0 Comments

: Your story has to make sense, the plot has to make sense. It has to seem like the characters are making realistic decisions for their situation, with their goals. What they say and do cannot

@Gonzalez219

Load Full 0 Comments

: How to cite an interview in APA with multiple interviewees? I need to cite an interview with multiple interviewees in APA format, but the APA website only has an example with a single interviewee.

: Re: Documenting framework features and descriptions We have written a custom software framework and it has grown to the point where we are ready for documentation. This documentation will be used

More posts by @Gonzalez219

: Creating a persona for cross niche marketing Not strictly a writing question but this touches on some issues that some writers may face, and I thought maybe someone here may be able to help.

: Writing a book in a non native language I have a fantasy story in my head for several years now. I wrote an outline for a book and draw a crude map of the world. I even started writing

: Your story has to make sense, the plot has to make sense. It has to seem like the characters are making realistic decisions for their situation, with their goals. What they say and do cannot

: How to cite an interview in APA with multiple interviewees? I need to cite an interview with multiple interviewees in APA format, but the APA website only has an example with a single interviewee.

Login to post a comment!

0 Comments

Back to top