wikifying

From IndieWeb
(Redirected from wikify)
Jump to: navigation, search


wikifying is the practice of capturing information and ideas on the wiki. E.g. "We need to wikify that FAQ, concept, jargon, or etherpad".

Contents

Why

Wikifying both in general, and particular subjects, notes, or documents, helps grow the searchable & discoverable commons of the IndieWeb community.

Is it IndieWeb related? Great, add it to the wiki. Not sure? See examples of what (not) to add:

How to

Wikify yourself

If you haven't done so already, set up your own domain with rel-me links (see Getting Started) and use IndieAuth to log into the wiki.

Make your user page

Like many things in the IndieWeb, start by editing your own user page. Click that link, then click "edit this page."

If you're not sure what to put on your user page, start with your name and URL in an h-card:

<span class="h-card">[http://example.com/ Your Name]</span>

Your user page is also linked at the top right, with the domain name that you logged in with, just before "My Talk".

Setup a nickname with a small h-card template

Get Tantek Çelik with
{{t}}
Instead of User:Tantek.com
[[User:Tantek.com]]

To set up your own, see: How to make a small h-card template

Write down your itches

Main article: itches

Next, add an itches section where you capture what you want to work on for your own site, personal online digital presence, and personal digital device usage (e.g. even when offline) in general. E.g.

== Itches ==
* Add a more extensive [[h-card]] on my site
* Figure out a [[URL design]] for my posts
* Start posting [[notes]] manually at [[permalinks]]
* Try checking my site in indiewebify.me
* Check out [[IndieMark]] for additional ideas of things to add to my site

When you start collecting lots of itches, you may want to start prioritizing them, especially by what you're currently working on. Start a "Working on" section for that:

== Working On ==
* the next thing I'm working on for my site
* the next next thing I'm working on getting working on my site
* ... etc.


Lastly, check out others' User: pages, especially folks that have been doing this a while, to see what else you could add to yours and work on.

Focus

As this is the IndieWeb, and this is about your IndieWeb user page, it should be about answering this question, continuously:

  • What is the next thing you want to get working on your personal site?

This means for example that the following are better left out and pursued elsewhere - like on your own site!

  • A personal to do list (of other non-personal-site things) - your IndieWeb user page is about work on your personal site.
  • Asking others to do work for you. Note: requests for help with IndieWeb specific itches/projects are ok, but address them to everyone, not just individuals. This is about what you want to work on - not asking others to do work.
  • Trying to get silos to do things, in general or with specific accounts - instead, document individual silo issues on the specific silo wiki pages, and follow-up there. Your itches should be about your personal site, not silos.

Incremental Wikifying

Main article: expand a page

There's lots of incremental wikifying to help with.

  • fixing typos
  • adding IndieWeb Examples - if you find a page for a technology you support on your site, or a project you use on your site, add yourself to the "IndieWeb Examples" for that page
  • add issues and questions (for FAQs)
  • collect questions/answers from IRC and add them to the appropriate wiki page
  • organize the content of a growing page into sections per expand a page

New pages

Main article: start a page

There's lots of new page creation you can help with. Create new wiki pages for:

  • new concepts or terms being discussed, e.g. in IRC
    • start with {{stub}} and a short definition!
    • especially if they're indieweb-related in some way
  • etherpads of notes from IndieWebCamp sessions after they're finished, to archive the session notes somewhere more findable / linkable
  • new projects you start using on your personal website; be sure to include your site in the IndieWeb Examples section on the page.

If something is not particularly indieweb-related, e.g. it didn't come up in the discussion of things that are indieweb-related, perhaps consider documenting it on Wikipedia instead (and/or using Wikipedia as a reference/citation).

Document your decisions

Once you've documented yourself on your User page, and started incrementally documenting your "Itches" and "Working On", as you get work done and deploy to your personal site, document your "major decisions", on your user page or perhaps in a "Implementation Design" section on your project page.

Examples:

Documenting your major design and implementation decisions will help you better consider when to revisit them, and when to work on new personal site features and functionality instead.

Define jargon

Any time someone uses a jargon term in IRC, or other indieweb related communications, go ahead and ask in the channel:

  • What is jargon term

This will prompt Loqi to either answer with the definition with the wiki, or to prompt you to define it with a link to create the page on the wiki.

You can then define it by clicking on that link, or answer answer the what is question:

  • A jargon term is a specific unobvious concept, or re-use of a word to mean something other than its common meaning.

Try to be specific and meaningful in definitions, and include why it is relevant to the indieweb (if that's not obvious from the description).

Avoid repeating words from the term, avoid generic abstract definitions, and minimize use of jargon terms in a definition (though use them if necessary, and then link/define them too).

Tweetable definitions

Check the definitions on wiki pages, and edit them so they are tweetable, as there is evidence that people will tweet good definitions that are of tweetable length (including a subsequent link to the page) - that's 116 characters (space + 23 characters for the tco'd link).

Progressive disclosure of content

A simple jargon-free (or minimal) tweetable definition is an important first step in providing content that is understandable by a broader audience, while still documenting all the important research and details that are discovered or invented by the community.

Nearly every page on the wiki can be improved in this regard, to provide progressive disclosure of relevant content.

That is, wiki pages should start with offering quick, definitive information to a beginner.

And then incrementally document details only as needed for real world reasons / use-cases that provide benefits to those reading.

E.g. getting started can (still) be continuously improved in this regard. As can web hosting.

Common Page Structure

Most pages on the wiki have evolved to have a fairly common page structure, starting with a simple definition, and then adding additional sections such as:

  • Why
  • How to
  • IndieWeb Examples
  • Brainstorming
  • See Also

For more details on these and more, see:

Special Case Pages

In addition to the common structure across many pages, there are also several clusters or instances of special case pages.

Standards Pages

The wiki has pages for standards / specifications that were developed on the indieweb wiki, and have started or been formalized at W3C, and thus their pages (and subpages) here have evolved in support of those specifications.

While these are rapidly evolving, take a look at:

There are also pages that are about the indieweb usage of standards developed elsewhere or in active collaboration across communities, e.g. the pages for various microformats. Though these are generally structured in the common structure noted above, they may as a set have special patterns worth noting:

(stub) - help expand this section with documentation of patterns across this type of special page.

Historical Pages

Some pages help document history, e.g.:

(stub) - help expand this section with documentation of patterns across this type of special page.

Cross-Generation Pages

As certain IndieWeb building-blocks become more widespread, folks from later generations could benefit from re-organized content. In some cases, it may be beneficial to break out "introductory" content (including high-level explanations, examples with screenshots, tools and services, ...) from "developer" content (such as protocol diagrams, code snippets, brainstorming, ...) For example:

(stub) - help expand this section with documentation of patterns across this type of special page.

Related Articles

The above is very much specific to what is good wikifying for IndieWeb in particular.

Here are related articles on good writing, structure, and wikifying in general:

FAQ

Should this be on the wiki

Q: Do we really need this on the wiki?

A: Depends! In short, anything indieweb related is worth putting on the wiki, and sure it's up to someone to care enough to do it!

Here are some good examples of stuff to put on the wiki:

  • Anything directly IndieWeb related, especially directly to people in the community with their own sites:
    • Technologies (e.g. Apache) people are using to setup/build/run/maintain/monitor their indieweb site
    • Services (e.g. web hosting) people are using with their indieweb site
    • Events or podcasts that discuss the independent web or IndieWeb in particular, including events with only a single related talk (be sure to list the specific talk)
    • jargon representing technology used as part of an IndieWeb site
    • silos that have prior art (UX, design, formats, protocols) for things we want to rebuild independently

What should not go on the wiki

Q: If all that makes sense on the wiki, what does not make sense on the wiki?

A: There are so many things that do not need to be on the wiki that it's hard to list them all. Obviously aside from stuff like code-of-conduct violations, here are a few which we've seen added then decided were better removed, that seem to fall into the pattern of when someone is passionate about something totally not indieweb related, and wants to add it to the wiki.

  • Random stuff. In general, random things that lack an obvious IndieWeb connection are better left to Wikipedia, and using Wikipedia links rather than creating less useful stub pages on the IndieWeb wiki. E.g.
    • technical terms. If a technical term does not have a direct obvious connection to the IndieWeb, no need for it to be documented here
    • organizations. If an organization has no relation to anything independent it can probably be left out.
      • Exception: As noted above as silos, we are documenting any/all sites/services that anyone in the community has used (or even has friends that have used) that has announced or is threatening to shut down, or has especially has UX that is worth capturing for prior art research purposes when designing our own indieweb features.
    • events. If an event has nothing to do with the indieweb, it does not need to be listed on the Events page.

Do I have to use the wiki and mediawiki syntax?

While it's nice to put content into the wiki using standard markup for it, we realize not everyone is a wiki fan, knows how to do it, or even may have the time to learn to do it. (Documenting what you've done is both important and work enough.)

  • An alternate option is to simply practice the Indieweb principle of posting on your own site first where you have ultimate control. Then webmention "Indieweb" (for Superfeedr) or dump the link into chat. As long as you license your content as CC0 for that post, someone will surely add it to the wiki on your behalf.
  • Users shouldn't feel guilty for adding content as best as they can (markup/formatting or not) where they feel it's appropriate. Others will come along and clean bits up in the near future. Nor should they hesitate to ask for help in chat if they'd like to learn more about wikifying.

Related IRC chats:

See Also

Personal tools
Namespaces
Variants
Actions
Recent & Upcoming
Resources
Toolbox