- Tutorial or Documentation?

From: [at]} <Bob>
Date: Mon, 4 Apr 2005 19:10:06 +0100

----boundary-LibPST-iamunique-447943845_-_-
Content-type: text/plain

Hi,

>> Now, how do we move forward?

> I would like to try and write an example of what I mean. I am trying
> to think of something manageable as an example. But despite the long
> weekend I have an awful lot of work to do, so I can't promise anything.

I have not had enough time so far to try and write an example of the
type of documentation that I've been suggesting.

However, today I found a good example which illustrates exactly the
topic-based style, and shows how to program for a framework:
http://developer.apple.com/documentation/Cocoa/index.html

This is precisely the type of documentation that I believe Blackbox
needs.

I think it is feasible for a small group of people to produce
documentation like this because the individual topics are small. The
format is consistent and easy to follow. The indexing, searching and
retrieval is efficient.

-- 
Regards,
 Bob
--- BlackBox
--- send subject HELP or UNSUBSCRIBE to blackbox{([at]})nowhere.xy----boundary-LibPST-iamunique-447943845_-_-
Content-type: application/rtf
Content-transfer-encoding: base64
Content-Disposition: attachment; filename="rtf-body.rtf"
e1xydGYxXGFuc2lcYW5zaWNwZzEyNTJcZnJvbXRleHQgXGRlZmYwe1xmb250dGJsDQp7XGYwXGZz
d2lzcyBBcmlhbDt9DQp7XGYxXGZtb2Rlcm4gQ291cmllciBOZXc7fQ0Ke1xmMlxmbmlsXGZjaGFy
c2V0MiBTeW1ib2w7fQ0Ke1xmM1xmbW9kZXJuXGZjaGFyc2V0MCBDb3VyaWVyIE5ldzt9fQ0Ke1xj
b2xvcnRibFxyZWQwXGdyZWVuMFxibHVlMDtccmVkMFxncmVlbjBcYmx1ZTI1NTt9DQpcdWMxXHBh
cmRccGxhaW5cZGVmdGFiMzYwIFxmMFxmczIwIEhpLFxwYXINClxwYXINCj4+IE5vdywgaG93IGRv
IHdlIG1vdmUgZm9yd2FyZD9ccGFyDQpccGFyDQo+IEkgd291bGQgbGlrZSB0byB0cnkgYW5kIHdy
aXRlIGFuIGV4YW1wbGUgb2Ygd2hhdCBJIG1lYW4uIEkgYW0gdHJ5aW5nXHBhcg0KPiB0byB0aGlu
ayBvZiBzb21ldGhpbmcgbWFuYWdlYWJsZSBhcyBhbiBleGFtcGxlLiBCdXQgZGVzcGl0ZSB0aGUg
bG9uZ1xwYXINCj4gd2Vla2VuZCBJIGhhdmUgYW4gYXdmdWwgbG90IG9mIHdvcmsgdG8gZG8sIHNv
IEkgY2FuJ3QgcHJvbWlzZSBhbnl0aGluZy5ccGFyDQpccGFyDQpJIGhhdmUgbm90IGhhZCBlbm91
Z2ggdGltZSBzbyBmYXIgdG8gdHJ5IGFuZCB3cml0ZSBhbiBleGFtcGxlIG9mIHRoZVxwYXINCnR5
cGUgb2YgZG9jdW1lbnRhdGlvbiB0aGF0IEkndmUgYmVlbiBzdWdnZXN0aW5nLlxwYXINClxwYXIN
Ckhvd2V2ZXIsIHRvZGF5IEkgZm91bmQgYSBnb29kIGV4YW1wbGUgd2hpY2ggaWxsdXN0cmF0ZXMg
ZXhhY3RseSB0aGVccGFyDQp0b3BpYy1iYXNlZCBzdHlsZSwgYW5kIHNob3dzIGhvdyB0byBwcm9n
cmFtIGZvciBhIGZyYW1ld29yazpccGFyDQpodHRwOi8vZGV2ZWxvcGVyLmFwcGxlLmNvbS9kb2N1
bWVudGF0aW9uL0NvY29hL2luZGV4Lmh0bWxccGFyDQpccGFyDQpUaGlzIGlzIHByZWNpc2VseSB0
aGUgdHlwZSBvZiBkb2N1bWVudGF0aW9uIHRoYXQgSSBiZWxpZXZlIEJsYWNrYm94XHBhcg0KbmVl
ZHMuXHBhcg0KXHBhcg0KSSB0aGluayBpdCBpcyBmZWFzaWJsZSBmb3IgYSBzbWFsbCBncm91cCBv
ZiBwZW9wbGUgdG8gcHJvZHVjZVxwYXINCmRvY3VtZW50YXRpb24gbGlrZSB0aGlzIGJlY2F1c2Ug
dGhlIGluZGl2aWR1YWwgdG9waWNzIGFyZSBzbWFsbC4gVGhlXHBhcg0KZm9ybWF0IGlzIGNvbnNp
c3RlbnQgYW5kIGVhc3kgdG8gZm9sbG93LiBUaGUgaW5kZXhpbmcsIHNlYXJjaGluZyBhbmRccGFy
DQpyZXRyaWV2YWwgaXMgZWZmaWNpZW50LlxwYXINClxwYXINCi0tIFxwYXINClJlZ2FyZHMsXHBh
cg0KIEJvYlxwYXINClxwYXINCi0tLSBCbGFja0JveFxwYXINCi0tLSBzZW5kIHN1YmplY3QgSEVM
UCBvciBVTlNVQlNDUklCRSB0byBibGFja2JveEBvYmVyb24uY2h9fQCg4FIAFOMTYVgF
----boundary-LibPST-iamunique-447943845_-_---

Received on Mon Apr 04 2005 - 20:10:06 UTC