documentation

Why are software requirements always phrased with "shall" instead of "will"?

Why is it when I'm documenting requirements, it always has to be phrased as "It SHALL do this..." vs. "It WILL do this...". I know this is a odd question, but one I've never been able to find an answer to. It's always just been, "that's the way you write them". I know it's a silly question, but one that's always puzzled me. ...

Java Documentation

Hi guys, I have a school project which has to be coded in java and I'm having a little trouble getting started, mainly finding good documentation for this language. Is there anything for java like what http://www.php.net is for php? ...

Understandable documentation about R?

Does there exist understandable Free documentation for the R programming language, which is accessible to statistics-impaired people? The ideal documentation would include also motivation (an example) for using each statistical function. ...

How do you read JavaDoc?

What tools/websites do you use to read JavaDocs? I currently use Firefox with 20+ tabs open when working on a J2EE project to have all the documentation available which is not very usable, is eating too much memory and is not searchable. What I would expect from such a tool/website: Aggregate JavaDocs from different locations Direct...

Trying to sell Agile Development.

My work place is very archaic when it comes to software development. Essentially all projects are forced to use a waterfall approach requiring immense paperwork. I've always been a fan of agile development and recently was approach by my manager asking for me to help him put together a proposal to some of the managers/directors to try ...

SQL Server 2008 Reporting Services Report Definition Customization Extensions

I've been looking into report definition customization extensions (RDCE) in SQL2K8 recently and I've been at a loss to find much documentation or even chatter on the internet about it. MSDN has a brief overview: http://msdn.microsoft.com/en-us/library/cc281022.aspx And the sample report from this book http://www.amazon.com/Applied-Micr...

Where can I find a good introduction to maven?

Hi folks, I have a sufficient amount of experience with ant so far, but I am interested in learning more about maven. It seems really opaque. Can you recommend a good introduction to maven -- I'm looking for as much clarity and simplicity as possible. I suppose I'm looking specifically for information on maven 2 if it comes down to it....

What is the best documentation for snapshots and flow repositories in Spring Web Flow?

I'm looking for more and better documentation about snapshots, flow repositories, and flow state serialization in Spring Web Flow. Available docs I've found seem pretty sparse. "Spring in Action" doesn't talk about this. The Spring Web Flow Reference Manual does mention a couple flags here: http://static.springframework.org/spring-we...

Best Manual Editing Software

I'm writing a manual for our new software product... and M$ Word just doesn't cut it. So what is the best software or language to use for creating/editing a software manual? ...

Need business objects overview doc

Need help in explaining the good, the bad and the ugly of business objects to non-technical business users. Could you please point me to some solid/helpful/concise documentation on web? Yes Business Objects the tredemark, the BI reporting product. ...

Guides on writing documentation

I'm hoping to release a web app soon and a key part of that is going to be the documentation that explains how to use it. While I know of many guides on how to learn various languages I know of none that explain how to explain your application. Can you recommend any? To be a little more specific about the target audience They know w...

What is the best way to store software documentation?

An obvious answer is "an internal wiki". What are the pros and cons of a wiki used for software documentation? Any other suggestions? What are you using for your software documentation? Loren Segal - Unfortunately we don't have support for any doc tool to compile information from the source code comments but I agree it would be the best...

Anything better than PHPDoc out there?

Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output? ...

What would you use to write end user documentation for a WPF application

We're working on a WPF-based application and we would like to have user documentation included in the application. Our requirements: Must support multiple output formats (CHM,HTML,PDF) Be able to load the text into a WPF application Be familiar for a windows user Preferrable possible to give us context sensitive help within the applic...

What are some project management tips and processes for a single-developer team?

I usually have some project that I can do alone that take around 6 months to 1 year. I always try to have some "release" date and write few documentations (external to the code). My question is, what type of management do you use when you do not have a team with you but you are alone? Example, I was thinking about Agile Programming BUT...

Do you still use UML? How? What for?

Few years back everybody in our shop was crazy with UML. Now everybody seems to have cooled off. I am curious if there is still widespread use of UML in software projects. If so, is this usage limited to whiteboarding? Do you use it for documentation? Do you use tools to generate code from it? Related: Is UML Practical? ...

Tools to annotate images

What tools do you use to annotate images? I mean, for example, placing a screenshot into documentation with some text bubbles, arrows, numbers for references in text and so on. Sure, you can do all of these in general graphics editor, but a specialized tool (or plugin for a generic editor) would be so much nicer and should produce more...

Does anyone know of a good MAML editor

At work we use Sandcastle for creation of help files. I have been using SandCastleGUI for some time and I'm looking for a way to create additional pages in the help file. These pages are written in XML format called MAML. The only problem is that I couldn't find any decent editor for these file format. I'm looking for a WYSIWYG editor...

What types of requirements add the most value?

I am looking for input on where developers find value in requirements. I understand there are times and situations where requirements make a mess, but let's presume the person writing the requirements understands the business and what they need. Maybe requirements are needed for governance, or testing, or even because none of the coder...

"Information Not Found" page in Visual Studio 2008, VB.NET Express Edition

I'm experimenting with VS 2008 Express edition and when I hit f1 on a keyword or class name I seem to get the Information Not Found page more than 90% of the time. Is this a configuration problem? Is it because this is the "free-as-in-beer" Express edition? Did Microsoft move their online documentation since the version I downloaded? ...