Query: Looking for Example Wiki of Software Documentation

151 views
Skip to first unread message

@TiddlyTweeter

unread,
Aug 15, 2019, 5:33:27 AM8/15/19
to TiddlyWiki
As part of work on "Polly", with Mark S., (a multi-platform script-based support system for restoring, backing-up and cloning Wikis) I work on documentation at https://tidbits.wiki/polly/polly.html.

Basic TW is quite good for it.

But I'd love to see any wiki that have a more dedicated, more minimalist, approach to documenting software.

Do you know of any good example TW I could look at? (could be TWC or TW5)

Thanks for any help!

Best wishes
Josiah

@TiddlyTweeter

unread,
Aug 15, 2019, 6:10:26 AM8/15/19
to TiddlyWiki
Repeat for email users ...

TonyM

unread,
Aug 15, 2019, 11:26:14 PM8/15/19
to TiddlyWiki
Josiah

I think we need an edition for publishing and demos of people plugins and macros. This could be extended to support software in general.

If I may take this opportunity to point out the idea with Polly to use a restore method to build browser independant saving is sheer genius. However to use "restore" as a way to describe it is from my perspective not good. Why ? Because despite all the backups available to me I rarely ever need to restore. On the surface this makes Polly look like something I am unlikely to use, and this shortchanges what Polly can do.

Perhaps saving wikis from any browser without add-ons or server installs is a better description. In Polly s design restore is effectively how one saves. So I suggest calling it save and keep the word restore for the technical summary.

Regards
Tony

Mark S.

unread,
Aug 16, 2019, 12:33:57 AM8/16/19
to TiddlyWiki
Perhaps saving wikis from any browser without add-ons or server installs is a better description.

Yes, but a bit long.

Maybe, Polly the Parroting Tiddly Shadower ?


@TiddlyTweeter

unread,
Aug 16, 2019, 1:56:39 AM8/16/19
to TiddlyWiki
Whatever is used I think it should be *one* word, not a mutli-word description.

@TiddlyTweeter

unread,
Aug 16, 2019, 9:06:36 AM8/16/19
to TiddlyWiki
TonyM wrote:

However to use "restore" as a way to describe it is from my perspective not good. Why ? Because despite all the backups available to me I rarely ever need to restore. 


I agree that "restore" is ...

(1) on computers associated with recovery from failure;
 
(2) has resonances with diseases and general ennui--"he restored himself at the goat farm" 

HOWEVER, we need ONE word to replace it, not a sentence. And one that sums up its meaning. "Restore" is accurate, so what is a good synonym for it?

The closest understandable alternative single word I can think of is "REINSTATE". Would that be better for you?

TT 

coda coder

unread,
Aug 16, 2019, 11:52:29 AM8/16/19
to TiddlyWiki
Bank
Stash
Recover
Sync
Sanction
Unify
Unite
Alloy
Combine
Consolidate

Mark S.

unread,
Aug 16, 2019, 12:49:25 PM8/16/19
to TiddlyWiki

It's kind of doing the opposite of these.

So maybe

Unstash

or

Unstasher

(It's unstashing from downloads back to the original dir.)

George Goodman

unread,
Aug 16, 2019, 3:44:06 PM8/16/19
to TiddlyWiki
Perhaps the Latin equivalent of "recover" would work?
recuperet

TonyM

unread,
Aug 16, 2019, 6:39:33 PM8/16/19
to TiddlyWiki
My description was only meant to describe. You have a name Polly so may I suggest the most direct name.

Pollystore

Regards
Tony

@TiddlyTweeter

unread,
Aug 17, 2019, 6:40:45 AM8/17/19
to tiddl...@googlegroups.com
Tx all!

Very interesting!

TonyM, I understand your point. For me It was simply helpful to know "restore" invokes the wrong ideas. You are right.

After reflection, I thought, looking back, that, basically, Mark's idea to name the tool "Polly" was great! Its accurate and evocative. I also think our use of "Parrot", for one of her functions, makes very good intuitive sense, at least in English. 

So, given that our Polly bird has given us a lot I looked more into Bird Language to see if there are additional words that might work ...

Polly "restore" is a kind of "GLEANING / GLEAN" birds (https://en.wikipedia.org/wiki/Gleaning_(birds)) and humans do (https://en.wikipedia.org/wiki/Gleaning). Its an activity of finding and making your own. Its perhaps not so well known, though an entire movie was made about it ... https://www.youtube.com/watch?v=XZF3VRGgxTU, a serious French activity of reclamation.

And there is "ROOST/ROOSTING", which is the resting place, a home where a bird Returns to ...
 
Polly ROOSTS wiki? This is a common term that conveys, well, I think, a home destination wiki return to.
I think it is worth attention. 

This is also the related "PERCH/PERCHING". Wikis are perches of writing and ideas taht wander into download but find again their perch with Polly's help.

There are other Bird Terms that are good but they have other meanings too that unfortunately may confuse the issue, including BROOD, NEST & HOME. And much as I love NIDICOLOUS (Polly feeds the Wiki) I can't see it working.

Yours in thought
TT

Reply all
Reply to author
Forward
0 new messages