text, usually about how to use a program.

learn more… | top users | synonyms

-1
votes
1answer
97 views

explaining/documenting an intricate mechanism

I'm torn between two worlds, I have this very intuitive (but intricate) mechanism in a command line tool, and I'm wondering as to what extent I should explain this. I can go the simple way, not ...
0
votes
1answer
1k views

What should be covered in a UI Standards document?

I'm a coop student who is creating a web/desktop application design standards document for a company I'm working at. Each standard in the document needs to be supported by a reputable source. What ...
2
votes
3answers
270 views

How should I design a small help system for a Windows application?

Context I've written a simple, business application which generates a report from information in a database. The only user input required are two file paths--one to a list of items to report on and ...
2
votes
1answer
68 views

What is a good method for creating a guide for standardized markup?

I need to create a guide or wiki that outlines different standardized techniques for marking up reusable elements in our software. When adding new features our developers are often able to reuse or ...
8
votes
5answers
2k views

Which type of help system is best?

At my company we create Windows based desktop applications. In the past, we have created .chm files for our help documentation and have been happy with it. We have now been faced with some issues ...
7
votes
1answer
186 views

Quoting time and effort for UX research

Edit : I've added a little more detail to the main question here. There are many techniques and practices at our disposal to gain an understanding of the target audiences motivations and needs when ...
11
votes
2answers
19k views

example of a good software design document

Anyone got any online examples of good software design documents. I want personas, goals, scenarios and all that good stuff. I wish Cooper would have included a document with his books.
4
votes
3answers
188 views

Allow uploaded Word documents or require markdown?

I have a site for writing tutoring that currently requires the student to copy and paste from Word into an HTML textarea, removing all formatting. We've thought about letting the student upload the ...
8
votes
2answers
343 views

Full lifecycle, version controlled, UX documentation - Is this possible?

I'm currently trying to implement a usable UX documentation system , streamlining the flow of work between User Researchers/Usability specialists, Information Architects and Visual Designers. Just to ...