Are there any accepted standards or best practices for documenting a set of JSON API's? Done a fair bit of searching around and there seems to be a bit of a mish-mash of style / formats. Maybe making too big a deal over this ... at some level docs is docs, but figured I'd ask. ...
Some of our customers ask for end-user documentation in a format that’s suitable for printing. Currently, I use Microsoft Word 2002 to write the documents and a non-free PDF printer to generate a PDF file with searchable bookmarks. Then I store both files in the Subversion repositoryT. While it does the job, it has a few drawbacks: It ...
You can find many open source projects in the INTERNET (such as Linux,open office,...) But i did not find any open source project with a complete ,good and REAL documentation. I don't mean just source documentation. I mean, gathering costumer requirements, design patterns , and all paperworks. Kind regards ...
Sometimes I want to look up the implementations of functions in the stdlib, I've downloaded the sourcecode, but it's quite messy. Just greping is not really suitable because of the many hits. Does anyone know a webpage doxygen style that has the documentation. The same goes for the linux kernel. Thanks ...
Different browsers implement different things in different ways. For example, see the event model differences here Where can I find the complete official documentation of the brower's implementation? ...
Hello everyone! I really want to start developing deeper into the Linux kernel. I want to understand how it all comes together and how I can possibly make some changes or compile it for different architectures. I don't feel like buying another book, so I want to know, what are some good and free online guides to getting more into the Li...
So far I've just been tacking "java 6" at the end of my class-name search queries in google, but sometimes I'm looking for classes that I don't know the name of, but are designed for what I want to do. Have any tips or tricks for browsing the JDK docs efficiently? ...
I've been considering installing wikimedia (the software that runs wikipedia), as part of a documentation for our small software system for a small development team. I heard that Drupal has a book editing add-on where the documentations can be extracted, so I was wondering what other developers might suggest. I'll be using the system f...
I have to document a small code(A Game): analyze / design / Implement / ...etc the known steps I used to do this in software Eng. but how to do it in case of a code (Visual C#) I need Ideas , No solutions :-) or if there is an example on the net ! thanx in advance . ...
I don't seem to find any documentation on how to implement an home screen plugin for Nokia E52 devices. Does someone know how to do this or where this documentation is? ...
For instance, in multiprocessing.managers there is a function called MakeProxyType. This function isn't in the multiprocessing documentation at all, but its name doesn't begin with an underscore either. Disregarding the subject of whether or not it's actually useful to use MakeProxyType, would it be ok to use this function in my code? ...
Problem: I have to write a review discussing the technical aspects of two competing software system (Document management systems). I have to review scalability, availability, maintainability, usability, extensibility, cost, and other relevant aspects. Question: Is there a template or preferred method you have for writing this kind of do...
I'm tasked with creating a web service that will be used by several different developers using different platforms, working for different companies, and having greatly varying skill levels. As such, I would like to create documentation for this web service API that is both complete, and very easy to understand. Although I'm sure this i...
Hi, I'm in the middle of writing a build and deployment document for a major enterprise platform, and I would appreciate a good example to use as a template for how to structure the document. Can anyone point me towards a good example of a well written build document? It does not have to be an online document, but could also be includ...
I am building a library of virtual machines for development purposes. I need a way to document each virtual machine. When developers need a particular virtual machine they can just browse a catalog and find the most appropriate. Much of the software we develop is version dependent and we have many customers on different revisions. In...
Where are good and current resources for anyone hacking on the CDT (C/C++ development toolkit) for Eclipse? In particular, I would like to know more about the internal architecture and structure of the C++ parser, and how the AST, DOM, PDOM, Models, and UI interrelate and interact. My interest is in adding support for extensions to C++ t...
I was trying to get a good hold on Zend Framework API but it proved quite challenging with Modules, Models, Controllers, Views, Actions, ActionHelpers, ViewHelpers, Decorators, and addon libraries like ZendX_JQuery. That's excluding the 50+ other components ! So I thought a bit about visual (diagrammatic) API navigation. What I mean is ...
Hi, I am wondering what documentation compiler other developers use to transform the C# 3.0 XML comments into documentation. I had experimented with the Microsoft supplied tool in Visual Studio 20005, but am currently using Visual Studio 2010 Beta 2. I have heard of "Sandcastle", which was apparently used for VS 2010 Beta documentatio...
I'm trying to do some class inheritance in Python. I'd like each class and inherited class to have good docstrings. So I think for the inherited class, I'd like it to: inherit the base class docstring also append relevant extra documentation to the docstring Is there some "best practice" for doing this sort of docstring manipulation ...
I remember an addon for VS.NET which allows you to see the styled preview of an XML code comment when you mouse over. This is quite useful when typing XML comments to ensure that style is correct. I googled but couldn't find it, can anyone remind me what was that addon? Or am I just imagining things? :) ...