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.
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 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 6 years ago.
Improve this question
I want to develop a plagiarism checker for checking several source codes but I couldn't find any proper source code or even a resource to get an idea about it.
I have checked the Boss2 which is useless. they claim that they use Sherlock module for detecting plagiarism but it seems there is no such tools included in boss2.
if any open source detection tool is available for checking source code please let me know.
regards
I'm aware of open-source plagiarism detectors for text (e.g., WCopyFind), but not code.
I couldn't find... even a resource to get an idea about it.
The authors of the excellent closed-source tool MOSS have published a helpful paper about the technology.
I know the question is old, but I did land here from a google.
Sherlock is an open source plagiarism detector. Sherlock's home page is here
I wrote SimiCheck, and you are welcome to use it. If you are interested in an API, I could probably write one very quickly.
I wrote the original algorithm as part of the CrowdGrader peer-grading tool, but then I decided to make the comparison tools available independently.
SimiCheck can handle code, Word (.docx), html, pdf, text, ..., as well as .zip, .tar, .gz, .tgz, and some more formats, and can deal with variable renaming, code moves, code across multiple files, etc.
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 5 years ago.
Improve this question
I don't know how to say this, but is it me or there isn't a dedicated tutorial on how to make an extension, all I ever got was a PDF saying how to make one, but there is not documentation on how to create one...
The online PDF link is here.
I'm intrigued on creating Dreamweaver extensions. I have Dreamweaver CS5.
True, the Adobe documentation on extensions creation is very slim, especially if you are looking at the latest releases. What I think you should do is to look back to the origins.
First of all the SDK offers great examples (from 2003):
http://www.adobe.com/cfusion/exchange/index.cfm?event=extensionDetail&extid=1009962
Also there are two great books: Dreamweaver MX Extensions by Laura Gutman and Building Dreamweaver 4 & UltraDev 4 Extensions by Tom Muck and Ray West. I believe you may read free chapters online in places such Safari library or Google books.
The books are old, you have to understand and adapt for the new versions, but in essence everything stays the same.
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
Note: NOT Javascript. :-)
Hello,
I just had a random thought, and have decided to learn more Jscript. I know the basics, I'm proficient in HTML, XML and C++ BUT, there doesn't seem to be much docs on Jscript. The official MS Documentation for JScript contains a WHOPPING ONE WHOLE PAGE about web-page development in Jscript! And that page, is useless.
Is this the right documentation? I downloaded it from Microsoft's website. I have no idea where to go for descent docs related to Jscript, nothing on Gooogle, nothing in book shops, nothing anywhere.
Have you seen these detailed docs? They look quite comprehensive to me.
There are additional pointers to information in the references of the Wikipedia article.
There also seem to be several books available.