Tagged Questions
The documentation tag has no wiki summary.
4
votes
2answers
53 views
How to document/verify consistent layering?
I have recently moved to the dark side: I am now a CUSTOMER of software development -- mainly websites. With this new role comes new concerns.
As a programmer i know how solid an application ...
2
votes
4answers
97 views
how to layout good documentation
I need to write out a documentation for developers to be able to use some API web software how should i lay out a documentation? What should always be included? And does it need to be really long or ...
0
votes
0answers
25 views
What is the best way to document a VB.net toolkit library? [migrated]
I want to start building and documenting a toolkit for a small development shop. Googling around lead me to something called VBCommenter. Is that a good tool to use? Has anyone had experience with ...
1
vote
0answers
7 views
Embed document files into html [migrated]
In html i can do this
<iframe src="foobar.pdf" style="width:600px; height:600px;" frameborder="0"></iframe>
which would allow me to embed a pdf into an html file. What process would i ...
8
votes
5answers
180 views
Should a method comment include both a summary and return description when they're often so similar?
I'm a proponent of properly documented code, and I'm well aware of the possible downsides of it. That is outside of the scope of this question.
I like to follow the rule of adding XML comments for ...
4
votes
3answers
75 views
What could be some pitfalls in introducing a style guide and documentation generating software in a development team?
I'm considering using appledoc, a flavor of Doxygen for use in generating Objective-C code documentation, in order to create documentation for my company's iOS apps. The idea is that a server will ...
2
votes
0answers
90 views
Where is C# documentation using XML comments created (Visual Studio 2010)? [migrated]
Do you know where is this documentation created ?
Normally it can be created with :
/// <summary>
/// I just want to test something
/// </summary>
/// <param ...
2
votes
1answer
103 views
How often do you take notes, and how are you able to maintain a consistent amount?
I take notes about language features, project details, etc. I've noticed that I tend to take a lot of notes when I start learning a new aspect of a language or start working on a new project, but then ...
6
votes
6answers
247 views
Can code be the documentation in open source developer tools? How frequently is it?
It's understandable that after a big development effort, some OSS authors deem reasonable that the project users should make an effort too in order to get started.
Can the source code effectively be ...
0
votes
0answers
7 views
Can you make microsoft word display a black background with white text, but print the inverse? [migrated]
I am documenting some software in ms word.
I want white text on black background when viewing on the computer (It saves eyes and power),
But i want black text on white background to save ink in case ...
9
votes
6answers
301 views
Alternativates to HTML Help
We currently use a system called AsciiDoc which allows us to create documentation in a simple text markup. From that we can generate multiple output formats. We only make use of the pdf output and chm ...
3
votes
1answer
72 views
Software testing automation documentation
What document types could be used when describing software testing automation (on any phase, automation planning, test design, implementation, reporting)? Is there any standard types of documents?
If ...
6
votes
3answers
68 views
Is there a Django reference?
I am new to Django. I have found the official topic guides https://docs.djangoproject.com/en/1.3/ an excellent place to learn from. But now I am in a place where I need quick reference to see what ...
4
votes
1answer
98 views
Is there a general pattern that could be used to describe Data Migration?
In our company we have to dismiss a software and introduce a new one. I have received the task to follow and take care of the whole data migration.
We use 3 different data sources (each containing ...
5
votes
4answers
123 views
Should all developers on a team have equal role/responsibility in writing and updating software design documents
I've asked a very similar question few days ago, but because I presented too much of my company's current situation, most answers focused completely on something that I wasn't looking to answer. So I ...
