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.
Related
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 2 years ago.
Improve this question
I am new to StackOverflow so please do correct me if I need to provide any more information.
I am trying to integrate an anomaly detection into the PostgreSQL database system by plugging into its backend.
I would like to know if there is any place where I can find extensive back-end coding or integration examples. I am looking at papers regarding this topic and, so far, I have found a few which talk about the methods that the queries are classified and used for anomaly detection.
If you do know about any websites which might help me, please do provide links to the sites.
Thanks!!
Look for "hooks" in the PostgreSQL source tree. Studying the source of the auto_explain and pg_stat_statements contrib modules, which track query execution, will show you the way.
The source is its own book: it is well-documented and interspersed with README files that explain the design.
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
Background
There is a hardware project going on. A hardware accelerator has been being developed by a team of students but there is no general documentation.
There are READMEs here and there, some docxs and in-code (Verilog, C and Lua) comments, but nothing else. The code is written with Vim, versioned with Git and Markdown is our friend, even if we are not on Github (yet).
Since this “thing” is growing, I feel the necessity of writing down something (user manual? developer notes?) but I don't know where to start.
Question
When someone feels the urge of documenting his project, where does it start?
More specifically, what are the generally accepted criteria to do it and what are the best tools?
My hypothetical answer
We quite clearly need both a developer and user manual. One with details of the algorithmic solutions, the other... like for monkeys.
About the tools, I believe that something like a Github Wiki would work fine, but (1) we are not on Github and (2) wouldn't be LaTeX a better way of writing stuff in order to publicise it, eventually. I know we can get our Markdown rendered in a printable way with http://www.cocowrite.com/, but is it the most efficient solution? LaTeX would be a nuisance for collaborative editing and online HTML publishing.
A partial answer can be found here: “What tools are used to write documentation?”.
Second part of the answer can be found here: “What amount of documentation is needed for a non-trivial one-man software project”
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've been programming in common lisp for a while now, and I like how there's so much handy documentation on the language online; the problem is that I'm often offline and can't access it when I need it most.
Is there a PyDoc equivalent for common lisp (or even just man pages for the language) that I can download and use in the shell?
Cheers in advance.
You can download the CLHS and install it in various ways.
http://www.cliki.net/CLHS
that's an old question…
edit: as referenced on the Cookbook, we can read the HyperSpecs offline with either Dash (MacOS), Zeal (GNU/Linux) or Velocity (Windows).
we could ask or add it on devdocs: https://devdocs.io/
and take the data of the CL Ultra Spec: website, data
and of course browse the built-in documentation with Emacs (C-h, see the menu).
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 8 years ago.
Improve this question
What are the best free uml drawing tools?
All the ones I have found require membership payments and only offer limited functionality based to public users on a trial basis...rubbish!
For my (very simple) needs I used ArgoUML. I'm not an expert about, but I found it enough easy to use. It's open source and, on the web page, you can find a good user guide.
Have a look at StarUML ( http://staruml.sourceforge.net/en/ )
It's free, open source, and incredibly fully featured.
For a full list, check out the ones marked as Open Source here: http://en.wikipedia.org/wiki/List_of_Unified_Modeling_Language_tools
But I'd really recommend StarUML!
For my first two software engineering courses, I used the stand alone version of UMLet, but it is just for diagrams. It exports to standard graphics, or pdf. They also have an eclipse plugin version, but I never used it.
For a no frill drawing tool, I find Google Docs (drawings) pretty good. Note that printing works better under Mozilla than Chrome, strangely enough. In Chrome, I cannot get dashed lines to print.
Try UMLet. Supports Eclipse IDE.
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.