Suite Info
If you write suites, tell your users about yourself!
At the risk of taking away valuable namespace, I propose a convention for suite writers.
suite.yourSuite.suiteInfo
A suiteInfo subtable would go a long way toward helping your users.
Problem: A lot of suites don't have good author contact info or URL's. When an update is needed or there's a problem, we can't find the ones responsible.
Idea: Scriptwriters should include a suiteInfo subtable, with at least these minimal fields:
- authorName
- authorEmail
- version
- url
and optionally, also
- authorLocation (for fun)
- versionHistory
Here's a sample screenshot:
Advantages
Although this kind of info is often found in the readme, if it is in this form, it would be easy for other scripts to parse this information out.
A distribution system (like the proposed DOODADS) could use this kind of meta information.
In fact, a distribution system like DOODADS could require--or at least inititialize--these fields.
Alternatively, Userland might consider adding these fields to it's suite init script (@system.menus.scripts.newSuite).
Discuss
What do you think? What other fields would be good?
Comments to the "Script Meridian" Community List.
Thanks!
|
