: 4401 | 106125 | 11885

Add "Documentation" Object to Info List 
Use this IdeaSpace to post ideas about Domino Designer.

: 37
: 37
: 0
: Domino Designer
: documentation
: John Dillon376 31 Jan 2008
:
: / Email


I'd love to see a new "Documentation" object available in the Info List, as shown in the mock-up image, to make it easier to place all our remarks, history, design thoughts, etc. in one spot.

Currently we all have different ways to document our code.

Some write strings of text in the Options or Declarations area, others insert stuff in the Initialize subroutine, and still others create their own private functions called "VersionInfo," "How_To_Use_This_Library," or "How_It_Works."



Sometimes the Help Using/Help About features are employed, other times separate documents are created, and often external files (such as word processing docs or flowcharts) are used.



For the majority of my script libs and agents, something as simple as a new "Documentation" object in the Info List would be ideal and would replace all those other choices.



Stick it near the top, maybe even at the top, and let us put text (at a minimum) without having to use apostrophes or %REM/%END REM nests.



Yeah, there are other ways to skin this furball, but it sure would be convenient to have it all in one place.



Plus, exporting it to DXL would bring us much closer to having a really easy way to compile all the documentation with a push of the button, similar to what I've heard about in the Java world (JavaDoc?)



If we wanted to expand on the idea, this object could have a few sub-settings or properties, like Version Number (string), Version Date, Designer's Name, Owner/Sponsor's Name, and perhaps even rich text capabilities so we could attach that Visio diagram for the ProcessBeanCounterReports lib directly in the lib itself.



It's probably difficult for the IBM guys to do but since they're working in that space anyway (according to Mary Beth Raven at Lotusphere, the nested vertical scroll bars are going away), maybe it's not overly difficult. Maybe the Eclipse environment will make it even easier to accomplish.



(NOTE: Terminology references came from "Exploring Lotus Domino Designer" in Designer 6.5.1 Help. I hope I got them right!)



1) Slawek Rogulski8789 (31 Jan 2008)
Great idea!
2) Rob Goudvis6575 (31 Jan 2008)
I promote this idea.

In the meantime you could always (mis)use the declarations-section for this. Define a layout for your comment (like version, date, author, related issue, etc.) and there you have a structure that can be adapted easily.
3) Jan Schulz4378 (02 Feb 2008)
proper javadoc like functionality would be even better...
4) Jens Polster1566 (02 Feb 2008)
Lacking a designated place to stick general design documentation in I am using LotusScript.doc ({ Link } for LotusScript code, it automatically generates a javadoc-like documentation.










:
:

Welcome to IdeaJam™


You can run IdeaJam™ in your company. It's easy to install, setup and customize. Your employees, partners and customers will immediately see results.

Use IdeaJam to:

  • Collect ideas from employees
  • Solicit feedback and suggestions from employees and customers
  • Run innovation contests and competitions
  • Validate concepts
  • Use the power of "crowd-sourcing" to rank ideas and allow the best ideas to rise to the top

IdeaJam™ works with:

  • IBM Connections
  • IBM Lotus Quickr
  • Blogs and Wikis
  • Websphere Portal
  • Microsoft Sharepoint
  • and other applications.

IdeaJam has an extensive set of widgets and API's that allow you to extend and integrate IdeaJam™ with other applications.

Learn more about IdeaJam >>


4
Add server and database as optional parameters for @GetProfileField and @SetProfileField
9
Have an option to copy an URL from an e-mail (or other)
-1
System wide Web Query Save
56
Please update Domino to fully support TLS (SSL v3.1)
4
Integrated ICS OneUI Editor for Designer
0
Design Element PostSave event
55
When deleting user, delete archive & roaming files as well as mail file
0
Please make the 'Database Users' view collapsible
6
Agent context menu in editor tab eg. "Run Agent"
2
Give us @commands for splitting & joining table cells, and hence smarticons for the same







IdeaJam developed by