software documentation templates [closed] - documentation

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
Does anyone know any source of examples and templates for software requirements, build environment description and other kind of documentations that are common for software development?
Thanks!

The ReadySet templates from tigris are quite comprehensive though you need to know html or have a good html editor to use them.

The IEEE provides standards for software documentation. For instance, high level requirements are defined in IEEE 830-1993 Software Requirements Specification.
This is a standard I've learned in school (using a book called Software Engineering - an object oriented perspective by Eric J. Braude, but I would not specifically recommend it.) It's more suited to a traditional waterfall development model though.
Googling the standard number should get you a couple of interesting links.
(The IEEE 830-1993 standard is superseded by IEEE 830-1998.)

The arc42 project is about a free Software Architecture Documentation template similar to the Software Architecture Document of the Rational Unified Process (commercial).

The state of Texas has a fine framework for the whole system development cycle.

Related

API for a real life like 3D avatar that could read given text. Ulta HAL for Mac/Linux? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I am looking to build a voice based interactive automation system. To make the experience more realistic I am looking for 3D avatars that could read a given text(response) in real time.
The closest I found something on the net is Ultra HAL for windows (https://www.youtube.com/watch?v=hEtgfXbpCqI). I need something similar, expressive, programmable through an API and preferable for a MAC or Linux. TTS is not that mandatory.
Thanks for the help.
Sadly there is nothing comparable to the (15 year old) Haptek avatar technology (the underlying tech Ultra HAL uses). Even on the Windows platform. We use Haptek for Cassandra for all the reasons you want such a package. To my knowledge nothing else supports such high quality, 3D, emotively & verbally autonomous characters. Note: In-game 3D avatars are all carefully scripted and acted scenes and not actually interactive.
I would like to extend the question/request to the Android platform. Many developers could make great use of that. Cassandra certainly would.

Favorite Documentation Generator system? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I'm a jack-of-all-trades-master-of-none programmer and as I jump around languages, quality consistent documentation is becoming more and more important to me. I've recently been using Doxygen, but Wikipedia reveals the usual ridiculous list of similar frameworks.
What is your favorite documentation generator and why? (Vote where you agree to keep it tidy!)
I use different files written in MediaWiki MarkUp, since this is easy to learn for everyone. I convert this to HTML and a CHM file, and to LaTeX for the PDF documentation.
This was the most painless way for me to generate Online documentation AND printable documentation in one strike with a simple way of input.
The tools I use are org.eclipse.mylyn.wikitext with a custom DocumentBuilder for LaTeX, the Microsoft Help compiler (which sadly only runs on windows), and a LaTeX distribution.
EDIT: I managed to get the Microsoft Help compiler running with Wine, so my Linux build server is now able to create the whole documentation automatically.

Where is the NUnit.Mocks documentation? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Where is the documentation for NUnit's mocking library, NUnit.Mocks?
I can't find anything in their official documentation or wiki.
As I have been told recently Nunit.Mocks are not meant to be used for serious applications. Given it's obvious limitations you're better off with a different framework anyway...
NUnit.Mocks was originally developed for internal use in NUnit's own
tests, although we no longer use it for that purpose.
In addition, it has been useful as a teaching tool, allowing users to
gain familiarity with mocking techniques before moving on to more
serious frameworks.
For production use, we recommend you install a full-featured mock
object framework.
The NUnit project now uses NSubstitute and NUnit.Mocks is no longer
being developed.
Source: NUnit.Mocks 2.6.2

How to build a programmer's wiki [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
For years I've missed a wiki so everyone could describe the new tools programmed, the servers where they are running, svn information, the internal rules of programming, how-tos, code samples, etc.
The wiki might be used for the dozen of programmers in the company and the externals.
I've been using a pmwiki (easy install) and now I want a better approach.
What wiki do you use? What plug-ins? Do you think there are better systems than wiki for this?
We're using TWiki for internal dev stuff, and I don't particularly like it. I'd rather use MediaWiki, as that's what Wikipedia uses, and more people are familiar with it.
We've been using a TWiki for several years, but it is being retired and replaced by TRAC.
Wen we started using TWiki I had great hopes, but the requirement for a special markup (like here on SO) never caught on with the management and admin types.
TRAC, as a wiki, is no better in that regard, but it suported by our IT guys and brings more tools for the development process.

Software Design Website(s) [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
What websites (not books) document designs (UML or otherwise) for software applications?
Building architects have many resources available for inspiration and construction. I do not seek resources on constructing software (such as Meyer's Object-Oriented Software Construction), but rather examples of designs for software components or class diagrams that can be used as a starting point for developing an applcation.
Example applications might include:
Game System
Word Processor
User Interface
Telephony Call Control
Clinic Scheduling
Notification System
Incident Management
Network Monitoring
Restaurant Catering
Dispatching (Taxi, Police)
Selling Vacation Packages
The Design Patterns book is a good start, but a bit too low level.
Grady Booch has a great site for just this thing at
http://www.handbookofsoftwarearchitecture.com/index.jsp?page=Main
But you do have to register to look at the diagrams.
Do you mean things like Microsoft's Patterns and Practices?
For simple explanations, sample codes and use cases of common software design patterns, you can check out http://sourcemaking.com/design_patterns. They are generally aimed at solving common problems and can, in fact, be considered as re-usable architectures in software development.
For information related to domain-specific systems, such as games, there can be other domain-specific problems that have been addressed in different architectures, such as some of the links you have provided. Finding a single source which can list all this information in a unified architecture may not be possible, at best. Generic design patterns, such as those from the Gang of Four, is a better start for this reason, I believe.