This site has been retired. For up to date information, see handbook.gnome.org or gitlab.gnome.org.


[Home] [TitleIndex] [WordIndex

Foie Gras

What is it?

Fois Gras is a temporary name for the new help system editor that ProjectMallard will include. This isn't an official page. For now, it's more a general outline of things I'd / we'd like to see in such an editor.

Use Cases

There are 2 main use cases considered here:

Ninja Stealth

We (the doc team) want to encourage people to get into doc writing. One way in is to go through the gdp, sign up to mailing lists, read the style guide etc. This is a long, boring process that people detest (and no-one does).

The other, more exciting way (using wikipedia as a basis) is to press the "Edit" button, make you're change and its done. We want to encourage this. Not only will we get more quick-fixes, but some contributors may even stick around.

Therefore, we want Foie Gras to provide an environment to get in, make a change and get out quickly. It would also be easy to submit the changes to the gdp.

Hard Grind

These are our core writers. They're the ones that sit down and rewrite huge chunks of documents to reflect reality. They're the ones that have really gone through the process of learning details of how the gdp works and are on the mailing lists. We want Foie Gras to be comfortable for them too.

Basic Premises

Foie Gras will at a minimum have:

Would be Nice Stuff

The above is a checklist of absolutely essential (IMO) features. This section gives some of the "It would be fantastic to have these" blue-sky ideas that have been circulating in my head recently.

Other Stuff

Random assortment of other comments and such that aren't really user-features, but things to think about and ponder.

Use Cases Revisited

Now that's down, it's time to look at the test cases again.

Ninja Stealth

Provided the app starts quickly and can quickly parse documents / find chunks of text, the ninja user should have very little problem doing a quick fix as needed. The commit button would allow them to propagate the fix back to us. The reviewer mode allows for quick review of the patch and committing. User is happy to see their contribution accepted (via a nice reply email) and continues fixing small things. Maybe they'll eventually join us and get into more serious work.

Hard Grind

Right now, these people (okay, person) is dealing with lots of verbose XML. They don't like XML. They want to write about the software, not worry that all their tags are closed properly. The WYSIWYG nature allows them to do this. Built-in spell checker allows them to easily check for silly errors. The commit button also allows them to get their work done quickly without worrying about finding the right folder and committing. The reviewer mode allows them to quickly assimilate changes from others and produce better docs.

Translators

Translators are happy because they're always happy. More importantly, without all the XML to deal with (do po files include XML?), they can translate much easier. They can see the context of the translation much easier. More docs get translated.

In the End

I'm sure I'll add more to this slowly, but that's a start for now. Comments very welcome.

Comments

ThomasHarding


2024-10-23 11:37