- Pharo-dev - lists.pharo.org

[Pharo-project] Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse.
by Stan Shepherd Jan. 2, 2010

Jan. 2, 2010

Situation ----------- Pharo/Squeak is potentially a very productive development environment. It has not achieved the widespread use in production systems that we feel it deserves. Complication ----------------- The Pharo world relies on a few people with a lot of knowledge. Starting to use Pharo means relying on those people to provide the knowledge they have. The knowledge that is transferred this way is not captured for reuse. Lack of documentation is usually cited by people evaluating Pharo/Squeak for new projects. For example "#addScript: and #addStyle: are actually ment for internal use. It is currently used by the methods WAComponent>>#styles and WAComponent>>#scripts." http://n4.nabble.com/Script-in-head-tag-td98415.html This is not in the comments. It is tacit knowledge. I'm sure you know of similar examples; they are not rare. Resolution ------------- If documentation maintenance were separated from code maintenance, this tacit knowledge could be captured immediately, by the person who requested it. Maintaining documentation then becomes largely a task for the users of the system. Action -------- One possible mechanism would be to place comments in a wiki. For each class, and each method of that class, there would be a corresponding wiki section. Any user could update the comment at any time. The developer/maintainer of that class could revert any inaccurate edits with one click. Incorrect edits would not affect the function of a method, hence no requirements to unit test / integration test. Commits of code would ideally also update the wiki comment section. There is obviously potential for some problems here, but a wiki structure would make it easy to identify/reconcile parallel edits. When a build happens, a process would update the source with latest comments from the wiki. Plan ---- I'd be willing to put some time into a proof of concept, if people agree that it's worthwhile and they would use it. Any thoughts? ...Stan P.S. Other areas that could be maintained this way: Welcome information workspace on download images. Known problems. (Examples of class use) ... -- View this message in context: http://n2.nabble.com/Solving-the-documentation-problem-Capturing-tacit-know… Sent from the Pharo Smalltalk mailing list archive at Nabble.com.

9 22

[Pharo-project] where can I see the slices that were removed from inbox?
by Mariano Martinez Peck Jan. 1, 2010

Jan. 1, 2010

I need to load a slice in 1.0 which was integrated in 1.1 and removed from PharoInbox. Where can I find it? thanks mariano

2 2

[Pharo-project] I still don't understand how this work
by Mariano Martinez Peck Jan. 1, 2010

Jan. 1, 2010

I took a clean pharo1.0-10502-rc1dev09.12.2. I open Monticello Browser, and of course, there is no dirty (modified) package. I select the package OB-Standard, then select the repo http://source.wiresong.ca/ob , and click on changes 1) First, I would expect to have no changes with an Image I have just downloaded, without doing nothing and even when Monticello Browser showed me there is no dirty package. But.....this showed me several changes!!!

3 8

[Pharo-project] Cannot even browse a class in web image
by Mariano Martinez Peck Jan. 1, 2010

Jan. 1, 2010

Issue: http://code.google.com/p/pharo/issues/detail?id=1724 Pharo image: pharo1.0-10502-rc1web09.12.2 Pharo core version: 10502 Virtual machine used: Squeak 4.2.2beta1U.app Class browser used if applicable: O2PackageBrowserAdaptor. Steps to reproduce: 1. Open a class browser 2. Click on the class ByteArray from the package Collection-Arrayed 'MessageNotUnderstood: ByteSymbol>>hasWideCharacterFrom:to:' I attach PharoDebug.log

5 13

[Pharo-project] Can we integrate issue 1433 in 1.0 ?
by Mariano Martinez Peck Jan. 1, 2010

Jan. 1, 2010

This issue fixes in addition the big issue: http://code.google.com/p/pharo/issues/detail?id=1724 I am not sure of the impact of this change in a 1.0 core. Nicolas what do you think ? Thanks Mariano

2 1

Re: [Pharo-project] Solving the documentation problem. Capturing tacit knowledge. Knowledge reuse
by Stephan Eggermont Jan. 1, 2010

Jan. 1, 2010

Adrian wrote: >What about using a wiki to gather and edit comments > (as suggested by Stan) and then integrate them in >a second step so that they are kept together with >the code (as suggested by Stef)? Just a thought... I'd very much prefer an in-image solution and avoid integrating. In-image we have much better version info, and much better browsing available. Stephan

2 1

[Pharo-project] Utilities >> startUp registration??
by StÃ©phane Ducasse Dec. 31, 2009

Dec. 31, 2009

does anybody know if this is of any use? startUp SystemChangeNotifier uniqueInstance notify: self ofAllSystemChangesUsing: #event:. event: anEvent "Hook for SystemChangeNotifier" (anEvent isCommented and: [anEvent itemKind = SystemChangeNotifier classKind]) ifTrue: [self noteMethodSubmission: #Comment forClass: anEvent item]. ((anEvent isAdded or: [anEvent isModified]) and: [anEvent itemKind = SystemChangeNotifier methodKind]) ifTrue: [anEvent itemRequestor ifNotNil: [self noteMethodSubmission: anEvent itemSelector forClass: anEvent itemClass]]. ((anEvent isAdded or: [anEvent isModified]) and: [anEvent itemKind = SystemChangeNotifier methodKind]) ifTrue:[ InMidstOfFileinNotification signal ifFalse: [Utilities changed: #recentMethodSubmissions]. ].

2 1

Dec. 31, 2009

11130 ----- - Cleaning Utilities... yet another step in the right direction

1 0

Dec. 31, 2009

11129 ----- - Remove deprecated method from 1.0. Took 10501rc1 checked all the senders of deprecated: and removed the corresponding ones in 1.1

1 0

Dec. 31, 2009

Hi I uploaded a core-image 11128 https://gforge.inria.fr/frs/shownotes.php?release_id=4734 Stef

2 1