Win a copy of Kubernetes in Action this week in the Cloud/Virtualization forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

How to document the User Interface.  RSS feed

Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

I have problem, or at least I think I have - I don't knoiw how/what to document it.
On the first line I explain how the class works and for what was desinged -also with exapmles, but I also I describe the GUI, how its look and how it renders the information. By example :
"The view uses to render the database file path a text field .....".

Is this right or I go a little bit to far with ui documetation.

[ January 24, 2006: Message edited by: Mihai Radulescu ]
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!