Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I found a great article here:
http://www.codeproject.com/Articles/18204/ASP-NET-controls-to-display-enum-values
where I studied it, learned a lot, and incorporated it as a new class library in my Visual Studio Solution.
Having borrowed the code and utilized in a web application, what is the best way to link up the original article on CodeProject to my Visual Studio solution (multiple projects) both so I can "bookmark" this article for later reference by me and my team member(s) and give credit to the original developer who came up with the idea. One idea I had would be an AboutBox in the EnumControls class library but the more I think about that it seems a bit stupid (I really only want some doc available at design time for my co-workers and for my future leaky brain).
How about a works cited page (text file in your solution) and then comments in code files where the code is actually used. This gives you and the other developers some immediate context of where it came from, but the solution level text file provides an artifact in your software process.
The VB.NET XML comment (''') would allow for IntelliSense documentation as well, which may be overkill, but it would be available to developers at code implementation time.
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
Does being a game developer require more specific skills than a normal programmer ?
I found that some developers know graphic design and 3D motion etc... so they can work on full projects by themselves ....
so what is really needed to build a good foundation as a game developer ?
Very good question. I've been asking myself the same questions. That's why I did a deep research to get good answers.
Let's start this way. The most known project by a single developer is LSA (Lost soul aside) which is not even released, but the game developer claims that he did everything by himself. He is a designer. I've checked other projects as well. Every good single project has been made by a designer. So if you are a designer, you can develop a game yourself. If your a programmer without the design talent, I recommend a team work. If your asking yourself how is it possible that a designer can create a good game. The answer is simple. Game development with existing game engines (UE - Unreal engine) for example, is so simplified that you don't even need to use any programming language. You're just playing with objects and when you get the feeling, you can do a real masterpiece there.
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 needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
Can anyone give advice, or point to any guides, on how to manage a community of open source software developers in writing api documentation?
A typical, unmanaged, starting point for most projects is to have a project wiki where anyone can freely create pages, add content to existing pages, edit existing content etc. The problem is that, despite people's best intentions, the wiki can easily end up being a disorganised, poorly written, incomplete, written in disparate voices etc etc.
So, what to do to improve the quality of the documentation?
I suspect a key ingredient is clear editorial/style guidelines, something similar to http://en.wikipedia.org/wiki/Wikipedia:Encyclopedic_style#Information_style_and_tone. Can anyone point to an example of such a guide tailored specifically to software apis?
Are there any other practices that people have found useful? E.g. form a core team of editors and accept that most documentation that gets added by the community will most likely need to be 'strongly edited'?
The short answer, that the solution is social/human and not technical. The way to get good documentation for any project is to have someone with time, in charge of doing high level organization for the documentation, and then being involved in the development and user communities to ensure that the documentation remains up to date and continues to address the problems and confusions that users typically have.
Community projects have accepted that you need point people (i.e. "managers," for aspects of the project like "translation," and "release," and for various components. The same thing needs to happen for documentation.
As for tools, Sphinx is really great though it's not "wiki like," exactly you can use whatever version control system your project is comfortable with to store documentation and configure your web server to rebuild the documentation following commits/updates/pushes. Which has always worked just fine for any project I've worked on/with.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
Currently I'm wrapping up an application at the moment, and I'm at the stage where I need to document the application for anyone who wants to use it.
At this point, I just need something that will tell users how to use my program. Even though I tried to design it as user friendly as possible, I have a group of users who aren't tech savvy and need something they can refer to.
So my question is basically: What can I do to easily create help files?
This answer will pretty much assume you're using some version of Microsoft Visual Studio, although the first approach is generic enough to work on any OS with a HTML rendering engine.
You could create a series of HTML files, store them locally on the user's computer, and when the user calls up help, load those in the default browser (this being the same kind of approach Microsoft took with Visual Studio 2010). However, I think that's kind of a hacky solution.
There used to be a product called HelpStudio Lite; unfortunately it's been discontinued.
If you're willing to use Microsoft Help 2.0 (which was used through Visual Studio 2008 and some other products), you might want to take a look at http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2. Evidently it's some kind of wiki detailing how to put together your own Help 2.0 documents. I'm not sure if it will work with Visual Studio 2010 (this is because VS 2010 uses a new help system).
I really wish Microsoft would get their act together on the help documentation front.
EDIT: You may want to look at Sandcastle Help File Builder. I found it recommended at https://stackoverflow.com/questions/6023/what-are-good-tools-for-creating-compiled-html-help-files-chm... actually you may want to go read that thread as well.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
For me it's got to be the Microsoft SQL Server Cast and Convert reference. I must love that page, I seem to visit it several times a day.
PHP Documentation for me - clear, concise, user tips (although these are not always correct and secure - pinch of salt etc). Also good for typing directly into an address bar if you know the function name, eg php.net/in_array - straight to the function's page.
The YUI documentation has had a good number of views over my last few projects...a good example of a clear and concise API
Definitely should be http://www.w3.org/TR/xslt :)
It depends a lot on what I'm doing and what my toolset is. In generaly these days it is probably Stroustrup's The C++ Programming Language.
From time to time, I still find that people need my services maintaining/fixing/adding new features to ASP site (VBScript) pages from time to time (yuck). The MSDN VBScript reference is usually all I need.