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”
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
I like good documentations for source code, but I hate the documentation comments in the code. I found solutions to separate the code from the documentation for other languages, but not for Rust. So, is any solution to separate the source code from the documentation in Rust out there?
Edit: Many years have passed and this below answer is no longer true. See the comments.
I'm afraid there's none. I am following Rust ecosystem and I have never seen even a mention of anything like that. On related note, I think the comments should be in the code, and if you writing open source code in Rust I'd advise to stick with the standard ways of doing things, just for the sake of other people. Eg. I am a vivid advocate of tab indentation as opposed to spaces ("Indent with tabs, align with spaces"), yet because Rust community settled on (clearly inferior :) ) spaces, I use spaces in my Rust projects. It doesn't fit my preferences, but after getting over it, it makes mine and other people lives easier when cooperating.
As a workaround, I would suggest making your editor just aggressively fold comments.
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 into ways of documenting my code in a JavaDocs kinda way.
Any ideas?
I use UFT 11.52
So far I have seen NaturalDocs + Perl.
Any other ideas?
Thanks in advance.
At least one solution looks
practical,
mature,
is delivered in source code form (consists of one huge (but very professionally written) VBS script that generates the documentation fragments),
and is absolutely free:
VBSdoc, "A VBScript API Documentation Generator"
See http://www.planetcobalt.net/sdb/vbsdoc.shtml.
The author appears to be very competent, given his high SO rep (see https://stackoverflow.com/users/1630171/ansgar-wiechers), and the general quality of his website's content.
Of course, this one is built for standalone VBS scripts, not QTP/UFT scripts. But this should be no obstacle, given the source code is available.
I'd love to hear from you about experiences with this one. Feel free to edit them into this answer, be it accepted or not.
I had success using Natural Docs several years ago. It's one of the few things I blogged about: automated code documentation for QTP
There is a product called Test Design Studio, an IDE alternative for QuickTest and UFT. One of the key features it provides is the ability to generate detailed documentation. It uses XML-style comments to mark up your code, and those comments drive documentation. The same comments also drive detailed IntelliSense for editing your code.
It does exactly what you're talking about.
Test Design Studio
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
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.