Jak upravovat dokumentaci

Tento popis je pouze pro editaci anglické dokumentace. Všechny nové informace musí být přidány nejdřív v angličtině. Pokud chcete přeložit wiki do jiných jazyků (děkujeme), použijte prosím crowdin.

For hints how to format text (headline, bold…) and set links please see the „code syntax“ section of this page.

General

Máte-li jakékoliv dotazy, můžete kontaktovat dokumentační tým prostřednictvím Discordu.

V některém okamžiku bude navrženo, abyste vytvořili žádost o začlenění (pull request; PR), což je způsob, jakým jsou vaše změny v dokumentaci skutečně vloženy na webové stránky AAPS, které jsou uloženy v GitHubu. Ve skutečnosti není příliš těžké udělat PR a je to skvělý způsob, jak přispět. Tuto dokumentaci právě teď čtete z toho důvodu, že lidé jako vy udělali PR. Nebojte se, že uděláte chybu nebo nějak editujete špatné dokumenty. Vaše změny jsou přezkoumány než jsou zahrnuty do „formální“ dokumentace AAPS. Žádnou náhodnou chybou v procesu tedy nemůžete poškodit originál. Obecný proces je:

  • Edituje a vylepšuje kód nebo dokumentaci editací stávajícího obsahu.

  • Zkontrolujte, že vaše úpravy vypadají dobře.

  • Udělejte několik poznámek o tom, co je změněno, aby lidé mohli porozumět editacím.

  • Vytvořte PR, která žádá správce, aby se tyto změny použily.

  • Ten provede přezkum a buď (1) sloučí vaše změny, (2) přidá komentář k vašim změnám, nebo (3) založí nový dokument s vašimi změnami.

(Poznámka: Pokud se učíte spíše vizuálně, existuje YouTube video zde ukazující, jak PR funguje.)

Například: chystáme se upravit AndroidAPSdocs. To lze udělat na jakémkoli Windows PC, Mac atd. (libovolném počítači s připojením k internetu).

  1. Go to https://github.com/openaps/AndroidAPSdocs and hit Fork in the upper right to make your own copy of the repository.

Klonování repozitoře

  1. Přejděte na jakoukoli stránku a přejděte na stránku, kterou chcete upravit. You can click on the „Edit in GitHub“ link in the upper right corner. This is only possible for English pages.

edit doc

Or click the pencil icon that appears in the top bar of the page contents to be edited. Budete muset být již přihlášeni do svého účtu na Githubu (pokud ho nemáte, je snadné si ho vytvořit).

RTD io

  1. Libovolnou možností v kroku 2 vytvoříte nový branch ve svém repozitáři, kde budou uloženy vaše změny. Udělejte své úpravy do souboru.

We are using markdown for the docs pages. The file have got the suffix „.md“.The Markdown specification is not fixed and we use at the moment the myst_parser for our markdown files. Take care to use the correct syntax as described below.

režim náhledu

  1. Pracujete v záložce „<>Edit file“. Vyberte záložku „Preview changes“ pro nový náhled, abyste zjistili, že vše, co jste změnili, je to, co jste chtěli. Pokud vidíte, že je potřeba další zlepšení, vraťte se zpět na záložku editace a pokračujte.

potvrdit komentáře

  1. Když jste dokončili své úpravy, přesuňte se do dolní části stránky. V obdélníku dole napište komentář do textového pole „Add an optional extended description…“. Výchozí název má jméno souboru. Zkuste přidat větu s vysvětlením důvodu změny. Pomůže to při kontrole, o jakou změnu se pokoušíte.

vytvořit žádost o přijetí změn

  1. Klikněte na zelené tlačítko „Propose file changes“ nebo „Commit changes“. Na stránce se pak objeví tlačítko „Create Pull Request“ a znovu na další stránce klepněte na tlačítko „Create Pull Request“.

Sledování PR

  1. Tím dokončíte žádost PR. GitHub přiděluje PR číslo, které se nachází za názvem a hashovou značkou. Return to this page to check for feedback (or, if you have GitHub notifications emailed to you, you will get emails notifying you of any activity on the PR). The edit will now be in a list of PR’s that the team will review and potentially give feedback on before committing to the main documentation for AAPS! Pokud chcete zkontrolovat pokrok ve zpracování PR, můžete kliknout na symbol zvonku v horním pravém rohu svého účtu na GitHub a uvidíte všechny své PR.

Sledování PR

PS: Your fork and branch will still be sitting on your own personal GitHub account. Po oznámení, že Váš PR byl sloučený, můžete odstranit branch, pokud do něj nechcete dělat další změny (V kroku 8 bude odkaz na odstranění branche, jakmile bude PR uzavřen nebo sloučen). Pro budoucí úpravy, pokud budete následovat tento postup, budou změny vždy začínat aktualizovanou verzí repozitáře AndroidAPSdocs. Pokud se rozhodnete použít jinou metodu pro vytvoření PR žádosti (např. editace začínající z vaší kopie repozitáře), budete muset zajistit, aby Váš repozitář byl aktuální, a to nejprve provedením „Compare“ a sloučením všech aktualizací, které se udály od doby, kdy jste naposledy aktualizovali svůj repozitář. Protože lidé často zapomínají aktualizovat svůj repozitář, doporučujeme použít pro PR proces popsaný výše, dokud se neseznámíte s detaily fungování „Compare“.

Code syntax

We are using markdown for the documentation pages. The files have got the suffix „.md“.

Markdown is a very simple text formating language which separates text content from text formating.

The writer only e.g. marks a headline as level 1 headline and the markdown processor generates the necessary HTML code during processing to render the heading in HTML.

The idea behind this is that

  • the writer should think about the text and not the formatting first,

  • the markdown text is open for exchange between different markdown tools instead of e.g. proprietary tools like Microsoft Windows and

  • you can generate several output formats from one markdown file.

Markdown is not a 100% fixed standard and we try to stay as near as possible to the standard, to

  • stay flexible to change markdown tools as needed or forced in the further innovation of markdown tools and markdown SaaS services and

  • enable us to use translation services to translate the English language in a target language like French or German. They can work on markdown but not complex formatting codes, because they can’t separate content from layout, which might be fatal.

Headlines

  • Headline 1: # headline

  • Headline 2: ## headline

  • Headline 3: ### headline

  • Headline 4: #### headline

We try to avoid further levels of headlines.

Text format

  • bold: **text**

  • italic: *text*

  • bold italic: ***text***

Ordered list

1. first
1. second
1. third

  1. Po přidání obrázků nebo provedení úprav můžete odeslat PR (Pull request) do hlavní větve AndroidAPSdocs.

  2. sekund

  3. third

Unordered list

- one element
- another element
- and another element

  • one element

  • another element

  • and another element

Multi level list

You can insert lists in lists by indenting the next level with 4 more spaces to the right than the one before.

1. first
1. second
1. third
  1. one element
  1. another element
  1. and another element
1. four
1. five
1. six

  1. Po přidání obrázků nebo provedení úprav můžete odeslat PR (Pull request) do hlavní větve AndroidAPSdocs.

  2. sekund

  3. third

    1. one element

    2. another element

    3. and another element

  4. four

  5. five

  6. six

Images

To include images you use this markdown syntax.

  • images: ![alt text](../images/file.png)

The type of image should be PNG or JPEG.

Images names should confirm to one of following naming rules. In the example I use png as suffix. In case you use JPEG please use jpeg as a suffix instead.

  • filename-image-xx.png where xx is a unique double digit number for the images in this file.

  • filename-image-xx.png where xx is a meaning full name for the author of the md file.

Images are located in the images folder for the english language and propagated to the other languages automatically by Crowdin. You have nothing to do for this!

We are not translating images at the moment: images should contain the minimum possible text to allow accessibility to non-English readers.

(make-a-PR-image-size)= Use a reasonable size for the images which must be readable on PC, tablet and mobiles.

  • Screenshots from web pages images should be up to 1050 pixels wide.

  • Diagrams of process flows should be up to 1050 pixels wide.

  • Screenshots from the app should be up to 500 pixels wide. Do not place them side to side if not necessary.

Notes, Warnings, Collapsing Notes

You can add notes and warning boxes to documentation.

Furthermore you can add collapsing notes for detailed information which would users who are not interested in the details quench to read the text at all. Please use these carefully as the documentation should be as easy to read as possible.

Poznámky

```{admonition} Note headline
:class: note
This is a note.
```

Note headline :class: note This is a note.

<br />#### Warnings

````
```{admonition} Warning
:class: warning
This is a warning.


```{admonition} Warning headline 
:class: warning
This is a warning.
```

#### Collapsing Notes



{admonition} further detailed readings for interested readers
:class: dropdown

This admonition has been collapsed,
meaning you can add longer form content here,
without it taking up too much space on the page.

Tables

Avoid using tables with long texts as the contents is difficult to set in Markdown, they will usually not fit in a mobile phone screen width, and probably won’t display the same after translation.

Style Guide

Obsah

  1. English language writing tips

  2. AAPS-specific writing notes

  3. Useful references

Image 1. English language writing tips

Use language that is appropriate for the reader

Use plain English wherever possible. This helps non-native readers and also aids translation of AAPS documents into other languages. Write in a conversational way with the user, imagine you are sitting across the desk from the person you are writing for. Remember - most AAPS users do not have programming backgrounds. Diabetes itself also has a lot of jargon and abbreviations. Bear in mind that some people may be recently diagnosed, may not be as experienced as you with diabetes, or may have been given different diabetes training. If you use shorthand or an abbreviation, write it out in full the first time you use it, giving the abbreviation directly after it in brackets, like “super micro bolus (SMB)”. Also, link to the glossary. Technical terms which might not be familiar to the reader can be also be added in brackets.

Instead of: “What causes high postprandial BG peaks in closed loop?“

Use: “What causes a high BG peak after lunch (postprandial) in closed loop?“

Use plain words that everyone can understand

Find an A-Z of alternative words to make your writing easier to understand here:

https://www.plainenglish.co.uk/the-a-z-of-alternative-words.html

Privacy/licensing concerns:

Particularly if you record video or screenshots, make sure not to disclose your private details (API key, passwords). Make sure YouTube content is not openly listed, and needs a link from the documentation to view. Avoid drawing attention to infringed copyrighted materials (BYODA etc).

Keep sentences short, get to the point

  • Clear writing should have an average sentence length of 15 to 20 words.

  • This does not mean making every sentence the same length. Be punchy. Vary your writing by mixing short sentences (like the last one) with longer ones (like this one).

  • Stick to one main idea in a sentence, plus perhaps one other related point.

  • You may still find yourself writing the odd long sentence, especially when trying to explain a complicated point. But most long sentences can be broken up in some way.

  • Remove weak words: “you can”, “there is/are/were”, “in order to”.

  • Place keywords near the beginning of titles, sentences and paragraphs.

  • Be visual! Wherever possible provide a brief diagram, screenshot or video.

Don’t be afraid to give instructions

Commands are the fastest way to give instructions, but writers sometimes fear giving commands, writing “you should do this” instead of just “do this”. Perhaps people worry that commands sound too harsh. You can often solve this by putting the word ‚please‘ in front. However, if something must be done, it is best not to say ‘please’ as it gives the reader the option to refuse.

Instead of: “You should just think of it as a complete statement.“

Use: “Think of it as a complete statement.”

Mostly use active verbs, rather than passive verbs

Example of an active verb:

  • “The pump (subject) delivers (verb) the insulin (object).”

“delivers” is an active verb here. The sentence says what is doing the delivering before it says what is being delivered.

Example of a passive verb:

  • “The insulin (subject) is delivered (verb) by the pump (object)”

“delivered” a passive verb here. The subject and object are switched around, compared to the active verb sentence. We have had to make the sentence longer by introducing “is” and “by the”. Also consider starting with the active verb.

Instead of: “You can connect your pump with the phone through the AAPS pump menu, and there are a number of pumps available for you to connect with.”

Use: “Connect your desired pump to the phone through the AAPS pump menu.”

Passive verbs can cause problems:

  • They can be confusing.

  • They often make writing more long-winded.

  • They make writing less lively.

Good uses of passives

There are times when it might be appropriate to use a passive.

  • To make something less hostile - ‚this bill has not been paid‘ (passive) is softer than ‚you have not paid this bill‘ (active).

  • To avoid taking the blame - ‚a mistake was made‘ (passive) rather than ‚You made a mistake‘ (active).

  • When you don’t know who or what the doer is - ‚the England team has been picked‘.

  • If it simply sounds better.

Avoid nominalisations

A nominalisation is the name of something that isn’t a physical object, such as a process, technique or emotion. Nominalizations are formed from verbs.

Například:

Verb

Nominalization

dokončeno

completion

introduce

introduction

provide

provision

fail

failure

They are often used instead of the verbs they come from, but they can sound as if nothing is actually happening. Too many of them can make writing very dull and heavy-going.

Instead of: “The implementation of the method has been done by a team.”

Use: “A team has implemented the method.”

Use lists where appropriate

Lists are excellent for splitting information up. There are two main types of list:

  • A continuous sentence with several listed points picked out at the beginning, middle or end.

  • Separate bullet points with an introductory statement.

In the bulleted list above, each point is a complete sentence so they each start with a capital letter and end with a full stop. Use bullet points rather than numbers or letters, as they draw your attention to each point without giving you extra information to take in.

Mythbusting

  • You can start a sentence with and, but, because, so or however.

  • You can split infinitives. So you can say “to boldly go”.

  • You can end a sentence with a preposition. In fact, it is something we should stand up for.

  • And you can use the same word twice in a sentence if you can’t find a better word.

Optimizing writing style by purpose

To keep the documentation clear and short, we write different sections of the documentation in different styles.

An “explanation” style is used for the introduction, background and knowledge development sections.

A “How-to-guide” style (with minimal explanation) is used for building, configuring AAPS, and some of the troubleshooting sections.

A tutorial helps the pupil acquire basic competence. The user will learn by doing.

Image

Image Tutorials (e.g. teaching a kid to beat egg whites)

  • narrator directly talks to the reader: In this tutorial you will (we) could be used to convey “we are in this together” frame-of-thought in some rare cases

  • Future Tense -> to show the final target

  • Imperative Tense -> to do the tasks -> Concrete steps - avoid abstract concepts

  • Past Tense -> to show accomplished tasks -> Quick and immediate visible results

  • Minimum Explanations -> strict necessary to complete the task - what and why

  • Ignore options/alternatives/…. No ambiguity

  • Step Transitions: finish a step with a sentence leading to the next step as a logical progression flow. Example: You have now installed the Let’s Encrypt client, but before obtaining certificates, you need to make sure that all required ports are open. To do this, you will update your firewall settings in the next step.

  • Tutorial Title (Level 1 heading)

  • Introduction (no heading)

  • Prerequisites (Level 2 heading)

  • Kroky:

  • Step 1 — Doing the First Thing (Level 2 heading)

  • Step 2 — Doing the Next Thing (Level 2 heading)

  • Step n — Doing the Last Thing (Level 2 heading)

  • Conclusion (Level 2 heading)

    • The Language of Tutorials

      In this tutorial, you will…

      Describe what the learner will accomplish (note - not: “you will learn…”).

      First, do x. Now, do y. Now that you have done y, do z.

      No room for ambiguity or doubt.

      We must always do x before we do y because… (see Explanation for more details).

      Provide minimal explanation of actions in the most basic language possible. Link to more detailed explanation.

      The output should look something like this…

      Give your learner clear expectations.

      Notice that… Remember that…

      Give your learner plenty of clues to help confirm they are on the right track and orient themselves.

      You have built a secure, three-layer hylomorphic stasis engine…

      Describe (and admire, in a mild way) what your learner has accomplished (note - not: “you have learned…”)

Image How-To Guides (e.g. a recipe)

A how-to guide’s purpose is to help the already-competent user perform a particular task correctly.

  • HOW-to

  • narrator directly talks to the reader: In this tutorial you will

  • Future Tense -> to show the final target

  • Conditional Imperative Tense -> to get X do y -> Concrete steps - avoid abstract concepts

  • Minimum Explanations -> strict necessary to complete the task -> what and why

  • Ignore options/alternatives/…. No ambiguity, but you can link to the reference entry or explanation entry

  • How-to: Title (Level 1 heading)

  • Introduction paragraph

  • Optional Prerequisites (paragraph or Level 2 heading if more than 1)

  • Kroky:

  • Step 1 — Doing the First Thing (Level 2 heading)

  • Step 2 — Doing the Next Thing (Level 2 heading)

  • Step n — Doing the Last Thing (Level 2 heading)

  • Conclusion paragraph

    • The Language of How-To Guides

      This guide shows you how to…

      Describe clearly the problem or task that the guide shows the user how to solve.

      If you want x, do y. To achieve w, do z.

      Use conditional imperatives.

      Refer to the x reference guide for a full list of options.

      Don’t pollute your practical how-to guide with every possible thing the user might do related to x.

Image Explanation (e.g. Science behind why egg whites stiffen when you beat them)

An explanation clarifies, deepens and broadens the reader’s understanding of a subject.

  • WHY

  • Start with About

  • Provide context, link ALL relevant references

  • Discuss options/alternatives

  • Don’t instruct or provide reference (link to them)

  • State the unknown/moving targets etc…

  • About Title (Level 1 heading)

  • Introduction (no heading)

  • Optional Prerequisites (Level 2 heading)

  • Subtopic 1 (level 2 heading)

  • Conclusion (Level 2 heading)

    • The Language of Explanation

    The reason for x is because historically, y…

    Explain.

    W is better than z, because…

    Offer judgements and even opinions where appropriate..

    An x in system y is analogous to a w in system z. However…

    Provide context that helps the reader.

    Some users prefer w (because z). This can be a good approach, but…

    Weigh up alternatives.

    An x interacts with a y as follows:…

    Unfold the machinery’s internal secrets, to help understand why something does what it does.

2. AAPS-specific writing/updating notes

Author & Editor

For writing/updating the AAPS documentation, consider the process as consisting of two stages. These can be carried out by the same person at different points, or more than one person.

An author (e.g. you!) writes/edits a section of the documentation in a concise conversational tone, then passes it to the editor.

The editor (e.g. a fellow AAPS user, or the person who receives the pull request) reviews adherence to the style guide, edits the section for clarity and accessibility, removing as many words as possible (especially for tutorial/how-to sections). Reading the text out loud may help.

General AAPS points

  • For glucose values, state both mg/dl and mmol/l in each occurrence (also consider this for screenshots, if possible).

  • For consistency, use “AAPS” rather than “Android APS”.

  • Clearly state the version of Android Studio/AAPS you are writing for, or that the screenshots are taken from.

3. Useful References

https://dev.readthedocs.io/en/latest/style-guide.html

Diátaxis (diataxis.fr)

Technical Writer Style Guide Examples | Technical Writer HQ

DigitalOcean’s Technical Writing Guidelines | DigitalOcean

Top 10 tips for Microsoft style and voice - Microsoft Style Guide | Microsoft Learn

https://www.plainenglish.co.uk/how-to-write-in-plain-english.html

https://developers.google.com/style

https://www.mongodb.com/docs/meta/style-guide/screenshots/screenshot-guidelines/