: 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

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 by other developers to share knowledge. I am concerned with how to do the documentation for the features and descriptions.

My co-worker suggested a Word document with sections and a feature matrix. I am not too keen on that and would like to find an alternative. What have you used in the past, good and bad parts? I couldn't find anything in particular on documenting features, I guess looking at something like a bootstraps website is a good start but creating a website for this is not doable. Are there any charts that may aid in documenting the features?

Edit:
Custom Software Framework for building Web Applications. The framework is built using C# + .Net...

Load Full (1)

: How to identify whether a publisher is genuine or not? Despite an identical title: This question is in no means duplicate of this question. In my local area, there have been various ads running

@Deb2945533

Load Full 5 Comments

: Erotica is not a genre I read, but the lusting male gaze in some fantasy and sci-fi - I cannot say that I always find it offensive. On the contrary - I can find it quite pleasant. I

@Deb2945533

Load Full 0 Comments

: Writing about real people - not giving offence The Spy is a Netflix series about Israeli spy and hero Eli Cohen. In a recent interview, Eli's widow Nadia expresses great dissatisfaction with

@Deb2945533

Load Full 3 Comments

: How to plausibly write a character with a hidden skill TLDR How to keep a character's skillset hidden, when it will be key in the story later on? This must be done without magic and as subtly

@Deb2945533

Load Full 3 Comments

Login to post a comment!

1 Comments

Sorted by latest first Latest Oldest Best

@Gonzalez219

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)

Feed

: 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 @Deb2945533

: How to identify whether a publisher is genuine or not? Despite an identical title: This question is in no means duplicate of this question. In my local area, there have been various ads running

: Erotica is not a genre I read, but the lusting male gaze in some fantasy and sci-fi - I cannot say that I always find it offensive. On the contrary - I can find it quite pleasant. I

: Writing about real people - not giving offence The Spy is a Netflix series about Israeli spy and hero Eli Cohen. In a recent interview, Eli's widow Nadia expresses great dissatisfaction with

: How to plausibly write a character with a hidden skill TLDR How to keep a character's skillset hidden, when it will be key in the story later on? This must be done without magic and as subtly

Login to post a comment!

1 Comments

Back to top