|
I know, it is hard to document on the work you already do. Especially time-constraint project often miss good documentation.
Do you or the team you work in have some tricks to create some project-documentation? What are your best-practices?
Started by Mnementh on
, 9 posts
by 9 people.
Answer Snippets (Read the full thread at stackoverflow):
Documentation....
But one thing we.
You basicallyAt our company we make bad project-documentation, because of lack of time.
For us it starts with a Word Document.
Of this screencasts are some rudimentary project-documentation.
|
|
What kind of documentation you'd recommend to support for Agile project? What are the core metrics you use to detect amount of documentation needed? Do you think you can store all of project info as TFS work items?
Started by dimarzionist on
, 6 posts
by 6 people.
Answer Snippets (Read the full thread at stackoverflow):
In either case, don't write documentation....
It depends on the complexity of the project.
Documentation should only be captured and kept up to date if there is a need are responsible for keeping them up to date.
Stakeholders, users, etc..
|
|
I recently joined a new project utilizing Agile methodology. The documentation is scarce to none, except for sticky papers on the whiteboard indicating stories, completed, in-progress, etc. The project is a web app for a workflow that is fairly complicated...
Started by LuftMensch on
, 6 posts
by 6 people.
Answer Snippets (Read the full thread at stackoverflow):
Thus....
Agile Documentation Best Practices
Agile Documentation
Agile Documentation and maintainable code.
As little as your team and client is comfortable with .
Using balsamiq in my next project to see what I can do away with.
|
Ask your Facebook Friends
|
I love the php.net site's documentation for the php language. Its my favourite documentation for any project i have come across. Its really easy to jump to functions and quickly understand how to use them (or navigate to a better alternative solution)...
Started by JW on
, 8 posts
by 8 people.
Answer Snippets (Read the full thread at stackoverflow):
It is generated by a framework that can as StackOverflow is around, they all have... .
The grails documentation has impressed me.
Spring - awesome documentation, awesome javadoc.
JQuery
The Flourish library docs is cleanly done and practical .
|
|
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...
Started by amir beygi on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
As for paperwork, you make that sound like, and another who is ... .
It's just boilerplate design.
Remember nothing to do with documentation.
documentation have entered the picture?
There was a design document but it wasn't published.
|
|
Hello,
I started using Sandcastle some time ago to generate a Documentation Website for one of our projects. It's working quite well but we've always only written documentation for classes, methods, properties (...) in our project and had completely separate...
Started by Ben on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
</namespaceSummaryItem>....
It allows to specify namespace descriptions in the XML project file classes.
You Sandcastle Help File Builder.
Definition of project summary and namespace summary comments that will appear in the help file.
|
|
I've a java project which needs some documentation, is Doxygen the only way to go ?
I would like to document the code but also the architecture, the Makefiles, in 3 words, the whole project.
Maybe I should orient myself to eclipsewiki or something like...
Started by LB on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
It can create API documentation for Python, but ....
It creates beautiful documentation.
Personally, I've started writing everything using Sphinx.
You can use JavaDoc , and include an overview.html.
documentation tasks you require.
|
|
Hi there, i read a lot of threads on stackoverflow regarding the documentation production under visual studio.
i went on sandcastle website but i'm not sure it is what i'm looking for. I'm trying to produce a website msdn stile where my team can find ...
Started by frabiacca on
, 3 posts
by 3 people.
Answer Snippets (Read the full thread at stackoverflow):
Check this link : C# XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files
Example of how the documentation will look with style
Sandcastle is the Microsoft-made documentation generator, but ....
|
|
I have been writing software for about 2 years and am now in charge of determining what documentation is to be produced for software projects in my department due to being the only developer at the company.
I do not have any project management, design...
Started by Andrew on
, 8 posts
by 8 people.
Answer Snippets (Read the full thread at stackoverflow):
My documentation a requirements document....
This is a requirements document company, I needed to document what to do if they have problems while I was on vacation.
What your project will do to satisfy the customer requirements.
|
|
I just finished a relatively small project (~3000 lines of code in several modules) and I've been asked to produce a document for the project. I have no idea how to go about this as I've mostly written code for other programmers before. Do I describe ...
Started by solo on
, 4 posts
by 4 people.
Answer Snippets (Read the full thread at stackoverflow):
At a minimum you should document
how to build the software how to install Manual API documentation You could ....
There's not much in the way of "standard" documentation; "Javadoc"-style API docs are about on future projects.
|
