Full Code of thejameskyle/documentation-handbook for AI

Repository: thejameskyle/documentation-handbook
Branch: master
Commit: b1fb78abe1b7
Files: 5
Total size: 37.2 KB

Directory structure:
gitextract_sm0h6vdj/

├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── crowdin.yaml
└── translations/
    └── ru/
        └── README.md

================================================
FILE CONTENTS
================================================

================================================
FILE: CONTRIBUTING.md
================================================
# Contributing

## Translations

The English translation of this repo is maintained in this repository, for
other translations we use [Crowdin](https://crowdin.com/), if you would like to
contribute to one of the translations you can invite yourself to the Crowdin
Project [here](https://crowdin.com/project/documentation-handbook/invite).

Changes to the English translation will automatically be sent to Crowdin which
will notify translators of changes. When translations are completed, they will be
built and sent back to GitHub. There's a short delay, but if any part of this
process does not happen, please open an issue.

Once you set up your account on Crowdin you should be taken to
[this page](https://crowdin.com/project/documentation-handbook).

Click on the language you would like to contribute to and then click on
"README.md". You will be taken to the translation editor.

![Crowdin Translation Editor](https://cloud.githubusercontent.com/assets/952783/12076790/291e6cac-b170-11e5-989e-4cb2925e2b38.png)

On the left side you can see the handbook. In red are missing translations,
light green are translated, and dark green are translated and verified.

If you click on one of the sections, it will bring it up in the center panel
where you can enter a translation and save it.

If you click on a section with text formatting or links, Crowdin has a special
syntax for matching up the formatting.

![Crowdin translation format](https://cloud.githubusercontent.com/assets/952783/12076803/c1a83a52-b170-11e5-9925-329b129be959.png)

If you match the numbered `<0>...</0>` delimiters, Crowdin will build the final
translation with all the formatting and links of the original.

Once a translation is finished, it should only be a few minutes before the
changes get pushed to GitHub automatically.


================================================
FILE: LICENSE
================================================
Creative Commons Attribution 4.0 International

=======================================================================

Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.

Using Creative Commons Public Licenses

Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.

     Considerations for licensors: Our public licenses are
     intended for use by those authorized to give the public
     permission to use material in ways otherwise restricted by
     copyright and certain other rights. Our licenses are
     irrevocable. Licensors should read and understand the terms
     and conditions of the license they choose before applying it.
     Licensors should also secure all rights necessary before
     applying our licenses so that the public can reuse the
     material as expected. Licensors should clearly mark any
     material not subject to the license. This includes other CC-
     licensed material, or material used under an exception or
     limitation to copyright. More considerations for licensors:
  wiki.creativecommons.org/Considerations_for_licensors

     Considerations for the public: By using one of our public
     licenses, a licensor grants the public permission to use the
     licensed material under specified terms and conditions. If
     the licensor's permission is not necessary for any reason--for
     example, because of any applicable exception or limitation to
     copyright--then that use is not regulated by the license. Our
     licenses grant only permissions under copyright and certain
     other rights that a licensor has authority to grant. Use of
     the licensed material may still be restricted for other
     reasons, including because others have copyright or other
     rights in the material. A licensor may make special requests,
     such as asking that all changes be marked or described.
     Although not required by our licenses, you are encouraged to
     respect those requests where reasonable. More_considerations
     for the public:
  wiki.creativecommons.org/Considerations_for_licensees

=======================================================================

Creative Commons Attribution 4.0 International Public License

By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of
these terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the
Licensed Material available under these terms and conditions.


Section 1 -- Definitions.

  a. Adapted Material means material subject to Copyright and Similar
     Rights that is derived from or based upon the Licensed Material
     and in which the Licensed Material is translated, altered,
     arranged, transformed, or otherwise modified in a manner requiring
     permission under the Copyright and Similar Rights held by the
     Licensor. For purposes of this Public License, where the Licensed
     Material is a musical work, performance, or sound recording,
     Adapted Material is always produced where the Licensed Material is
     synched in timed relation with a moving image.

  b. Adapter's License means the license You apply to Your Copyright
     and Similar Rights in Your contributions to Adapted Material in
     accordance with the terms and conditions of this Public License.

  c. Copyright and Similar Rights means copyright and/or similar rights
     closely related to copyright including, without limitation,
     performance, broadcast, sound recording, and Sui Generis Database
     Rights, without regard to how the rights are labeled or
     categorized. For purposes of this Public License, the rights
     specified in Section 2(b)(1)-(2) are not Copyright and Similar
     Rights.

  d. Effective Technological Measures means those measures that, in the
     absence of proper authority, may not be circumvented under laws
     fulfilling obligations under Article 11 of the WIPO Copyright
     Treaty adopted on December 20, 1996, and/or similar international
     agreements.

  e. Exceptions and Limitations means fair use, fair dealing, and/or
     any other exception or limitation to Copyright and Similar Rights
     that applies to Your use of the Licensed Material.

  f. Licensed Material means the artistic or literary work, database,
     or other material to which the Licensor applied this Public
     License.

  g. Licensed Rights means the rights granted to You subject to the
     terms and conditions of this Public License, which are limited to
     all Copyright and Similar Rights that apply to Your use of the
     Licensed Material and that the Licensor has authority to license.

  h. Licensor means the individual(s) or entity(ies) granting rights
     under this Public License.

  i. Share means to provide material to the public by any means or
     process that requires permission under the Licensed Rights, such
     as reproduction, public display, public performance, distribution,
     dissemination, communication, or importation, and to make material
     available to the public including in ways that members of the
     public may access the material from a place and at a time
     individually chosen by them.

  j. Sui Generis Database Rights means rights other than copyright
     resulting from Directive 96/9/EC of the European Parliament and of
     the Council of 11 March 1996 on the legal protection of databases,
     as amended and/or succeeded, as well as other essentially
     equivalent rights anywhere in the world.

  k. You means the individual or entity exercising the Licensed Rights
     under this Public License. Your has a corresponding meaning.


Section 2 -- Scope.

  a. License grant.

       1. Subject to the terms and conditions of this Public License,
          the Licensor hereby grants You a worldwide, royalty-free,
          non-sublicensable, non-exclusive, irrevocable license to
          exercise the Licensed Rights in the Licensed Material to:

            a. reproduce and Share the Licensed Material, in whole or
               in part; and

            b. produce, reproduce, and Share Adapted Material.

       2. Exceptions and Limitations. For the avoidance of doubt, where
          Exceptions and Limitations apply to Your use, this Public
          License does not apply, and You do not need to comply with
          its terms and conditions.

       3. Term. The term of this Public License is specified in Section
          6(a).

       4. Media and formats; technical modifications allowed. The
          Licensor authorizes You to exercise the Licensed Rights in
          all media and formats whether now known or hereafter created,
          and to make technical modifications necessary to do so. The
          Licensor waives and/or agrees not to assert any right or
          authority to forbid You from making technical modifications
          necessary to exercise the Licensed Rights, including
          technical modifications necessary to circumvent Effective
          Technological Measures. For purposes of this Public License,
          simply making modifications authorized by this Section 2(a)
          (4) never produces Adapted Material.

       5. Downstream recipients.

            a. Offer from the Licensor -- Licensed Material. Every
               recipient of the Licensed Material automatically
               receives an offer from the Licensor to exercise the
               Licensed Rights under the terms and conditions of this
               Public License.

            b. No downstream restrictions. You may not offer or impose
               any additional or different terms or conditions on, or
               apply any Effective Technological Measures to, the
               Licensed Material if doing so restricts exercise of the
               Licensed Rights by any recipient of the Licensed
               Material.

       6. No endorsement. Nothing in this Public License constitutes or
          may be construed as permission to assert or imply that You
          are, or that Your use of the Licensed Material is, connected
          with, or sponsored, endorsed, or granted official status by,
          the Licensor or others designated to receive attribution as
          provided in Section 3(a)(1)(A)(i).

  b. Other rights.

       1. Moral rights, such as the right of integrity, are not
          licensed under this Public License, nor are publicity,
          privacy, and/or other similar personality rights; however, to
          the extent possible, the Licensor waives and/or agrees not to
          assert any such rights held by the Licensor to the limited
          extent necessary to allow You to exercise the Licensed
          Rights, but not otherwise.

       2. Patent and trademark rights are not licensed under this
          Public License.

       3. To the extent possible, the Licensor waives any right to
          collect royalties from You for the exercise of the Licensed
          Rights, whether directly or through a collecting society
          under any voluntary or waivable statutory or compulsory
          licensing scheme. In all other cases the Licensor expressly
          reserves any right to collect such royalties.


Section 3 -- License Conditions.

Your exercise of the Licensed Rights is expressly made subject to the
following conditions.

  a. Attribution.

       1. If You Share the Licensed Material (including in modified
          form), You must:

            a. retain the following if it is supplied by the Licensor
               with the Licensed Material:

                 i. identification of the creator(s) of the Licensed
                    Material and any others designated to receive
                    attribution, in any reasonable manner requested by
                    the Licensor (including by pseudonym if
                    designated);

                ii. a copyright notice;

               iii. a notice that refers to this Public License;

                iv. a notice that refers to the disclaimer of
                    warranties;

                 v. a URI or hyperlink to the Licensed Material to the
                    extent reasonably practicable;

            b. indicate if You modified the Licensed Material and
               retain an indication of any previous modifications; and

            c. indicate the Licensed Material is licensed under this
               Public License, and include the text of, or the URI or
               hyperlink to, this Public License.

       2. You may satisfy the conditions in Section 3(a)(1) in any
          reasonable manner based on the medium, means, and context in
          which You Share the Licensed Material. For example, it may be
          reasonable to satisfy the conditions by providing a URI or
          hyperlink to a resource that includes the required
          information.

       3. If requested by the Licensor, You must remove any of the
          information required by Section 3(a)(1)(A) to the extent
          reasonably practicable.

       4. If You Share Adapted Material You produce, the Adapter's
          License You apply must not prevent recipients of the Adapted
          Material from complying with this Public License.


Section 4 -- Sui Generis Database Rights.

Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:

  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
     to extract, reuse, reproduce, and Share all or a substantial
     portion of the contents of the database;

  b. if You include all or a substantial portion of the database
     contents in a database in which You have Sui Generis Database
     Rights, then the database in which You have Sui Generis Database
     Rights (but not its individual contents) is Adapted Material; and

  c. You must comply with the conditions in Section 3(a) if You Share
     all or a substantial portion of the contents of the database.

For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.


Section 5 -- Disclaimer of Warranties and Limitation of Liability.

  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.

  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.

  c. The disclaimer of warranties and limitation of liability provided
     above shall be interpreted in a manner that, to the extent
     possible, most closely approximates an absolute disclaimer and
     waiver of all liability.


Section 6 -- Term and Termination.

  a. This Public License applies for the term of the Copyright and
     Similar Rights licensed here. However, if You fail to comply with
     this Public License, then Your rights under this Public License
     terminate automatically.

  b. Where Your right to use the Licensed Material has terminated under
     Section 6(a), it reinstates:

       1. automatically as of the date the violation is cured, provided
          it is cured within 30 days of Your discovery of the
          violation; or

       2. upon express reinstatement by the Licensor.

     For the avoidance of doubt, this Section 6(b) does not affect any
     right the Licensor may have to seek remedies for Your violations
     of this Public License.

  c. For the avoidance of doubt, the Licensor may also offer the
     Licensed Material under separate terms or conditions or stop
     distributing the Licensed Material at any time; however, doing so
     will not terminate this Public License.

  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
     License.


Section 7 -- Other Terms and Conditions.

  a. The Licensor shall not be bound by any additional or different
     terms or conditions communicated by You unless expressly agreed.

  b. Any arrangements, understandings, or agreements regarding the
     Licensed Material not stated herein are separate from and
     independent of the terms and conditions of this Public License.


Section 8 -- Interpretation.

  a. For the avoidance of doubt, this Public License does not, and
     shall not be interpreted to, reduce, limit, restrict, or impose
     conditions on any use of the Licensed Material that could lawfully
     be made without permission under this Public License.

  b. To the extent possible, if any provision of this Public License is
     deemed unenforceable, it shall be automatically reformed to the
     minimum extent necessary to make it enforceable. If the provision
     cannot be reformed, it shall be severed from this Public License
     without affecting the enforceability of the remaining terms and
     conditions.

  c. No term or condition of this Public License will be waived and no
     failure to comply consented to unless expressly agreed to by the
     Licensor.

  d. Nothing in this Public License constitutes or may be interpreted
     as a limitation upon, or waiver of, any privileges and immunities
     that apply to the Licensor or You, including from the legal
     processes of any jurisdiction or authority.


=======================================================================

Creative Commons is not a party to its public licenses.
Notwithstanding, Creative Commons may elect to apply one of its public
licenses to material it publishes and in those instances will be
considered the "Licensor." Except for the limited purpose of indicating
that material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the public
licenses.

Creative Commons may be contacted at creativecommons.org.


================================================
FILE: README.md
================================================
# How to write high quality friendly documentation that people want to read

## Translations

<!-- - [English](/README.md)
<!-- - [Afrikaans](/translations/af/README.md) -->
<!-- - [العربية](/translations/ar/README.md) -->
<!-- - [Català](/translations/ca/README.md) -->
<!-- - [Čeština](/translations/cs/README.md) -->
<!-- - [Danske](/translations/da/README.md) -->
<!-- - [Deutsch](/translations/de/README.md) -->
<!-- - [ελληνικά](/translations/el/README.md) -->
<!-- - [Español](/translations/es-ES/README.md) -->
<!-- - [Suomi](/translations/fi/README.md) -->
<!-- - [Français](/translations/fr/README.md) -->
<!-- - [עִברִית](/translations/he/README.md) -->
<!-- - [Magyar](/translations/hu/README.md) -->
<!-- - [Italiano](/translations/it/README.md) -->
<!-- - [日本語](/translations/ja/README.md) -->
<!-- - [한국어](/translations/ko/README.md) -->
<!-- - [Norsk](/translations/no/README.md) -->
<!-- - [Nederlands](/translations/nl/README.md) -->
<!-- - [Português](/translations/pl/README.md) -->
<!-- - [Português (Brasil)](/translations/pt-BR/README.md) -->
<!-- - [Portugisisk](/translations/pt-PT/README.md) -->
<!-- - [Română](/translations/ro/README.md) -->
- [Pусский](/translations/ru/README.md)
<!-- - [Српски језик (Ћирилица)](/translations/sr/README.md) -->
<!-- - [Svenska](/translations/sv-SE/README.md) -->
<!-- - [Türk](/translations/tr/README.md) -->
<!-- - [Український](/translations/uk/README.md) -->
<!-- - [Tiếng Việt](/translations/vi/README.md) -->
<!-- - [中文](/translations/zh-CN/README.md) -->
<!-- - [繁體中文](/translations/zh-TW/README.md) -->

**[Request another translation](https://github.com/thejameskyle/documentation-handbook/issues/new?title=Translation%20Request:%20[Please%20enter%20language%20here]&body=I%20am%20able%20to%20translate%20this%20language%20[yes/no])**

---

For the last few years I have written a lot of documentation for projects like
Babel or Flow, blog posts, and guides such as these:

- https://github.com/thejameskyle/the-super-tiny-compiler
- https://github.com/thejameskyle/itsy-bitsy-data-structures
- https://github.com/thejameskyle/babel-handbook

I've tried to focus on the way that I write in order to make it more
approachable and more useful to everyone. There are a number of things that I
have learned over the years that I believe makes for high-quality and friendly
documentation.

> **Note:** Some of this only really applies when you are talking about things
> that require tons of documentation. Try to adapt this advice to fit what you
> are working on best.

Here they are as one massive list:

#### In general...

- Keep a lighthearted friendly tone. Don't spend time trying to prove how smart
  you are. Treat the reader as a close friend who doesn't have a lot of
  knowledge about the topic but is very interested.
- Don't assume prior knowledge about the topic. If you want to appeal to a
  large audience (i.e. not a research paper) then you are going to have people
  with very diverse backgrounds.
- Don't use words like "obviously" or "basically", I promise you will never
  *need* to. Just say what needs to be said in simple straight forward
  language. Never ever talk down to people (both of those words do, as well as
  others).
- Don't use idioms. Speak using more formal terms that are well defined. This
  makes it easier for non-native-english speakers and for translations to be
  written. If you do, you won't just knock it out of the park, you'll do a
  really good job.
- Use words that are easier to understand and translate (i.e. "list" instead
  of "enumerate"). Don't worry that you're being slightly more precise using a
  bigger word, think about how it will sound to someone unfamiliar with the
  topic.
- Keep things brief. Avoid giant paragraphs, breaking them apart into multiple
  paragraphs each with a clear point. If you are writing really long
  paragraphs, it's most likely that you aren't doing a good job explaining what
  you mean.
- Link to other places in the documentation often ***but*** only for additional
  information. Readers should not have to navigate through several pages to
  find the information that they need about one specific thing. Just inline the
  immediately relevant information and link off if they want to know more.
- Reuse the same small set of examples as much as possible, keep presenting the
  same problem and building on top of it. Don't make the user keep thinking
  about new problems, people can only focus on so many things. If you need to
  keep coming up with new examples, you haven't started in a good place, start
  over and come up with a better one.

#### When writing guides...

- Use as many code/cli/etc examples as possible, *show* the reader what you
  mean. This makes things far easier to translate and is generally much easier
  to follow than walls of text. Even if you aren't going to discuss the code
  directly it's good for giving context.
- Use headings frequently. This breaks things up when reading and often it is
  good for linking to specific information.
- If writing with multiple pages, think about how a single page leads into the
  next, point the user to the next page and make sure it follows naturally.
- Gently introduce a guide before diving into technical details. This gives
  context and readers are more likely to stay engaged longer.
- Tell one story at a time. You can re-explain the same concepts from different
  perspectives or for different use-cases.
- Don't clutter explanations with overly detailed examples. You don't need to
  implement a game of sudoku to explain how you might use your library with it.
  Typically if you have to explain the backstory of an example then it is too
  complicated and serves as a distraction from what you're teaching.
- Don't be afraid of foo's and and bar's. Using them removes mental overhead,
  it's explicitly saying to the reader "don't worry about what this is, is
  could be anything"

#### When writing api documentation...

- Think about API docs like they are guides on how to use them. Type signatures
  for input and output and a vague description isn't enough to be useful.
- Add information explaining the purpose of a group of APIs before diving into
  them. Also add any other relevant information or caveats. People are far more
  likely to read it this way.
- Use shared terminology with API names, examples, and explanations. Call
  something a single name no matter where you are referring to it, and name
  things
- Don't try to solve real world scenarios in code examples if they become any
  more complicated than the API already is. Do not implement algorithms, do not
  add a bunch of noisy implementation details that doesn't aid the user.
- Keep code examples extremely short. Your target should be ~3-5 lines of code,
  every line past that is a count against you. Think hard about the examples
  you are using.

#### Absolutely...

- Never use terms that are offensive to any group. There will never be a good
  reason to.
- Do not use gendered terms. Pronouns like he/she/her/him and gendered terms
  like actress/actor/waiter/waitress should all be thrown out and you should
  avoid using any terms or phrases that don't necessary refer directly to
  gender but have gendered connotations. For example, words "pretty", "curvy",
  "moody", or "bossy" all refer to women far more often than they do men.
- Avoid examples using people. You end up sounding like you're talking to
  children and it's easy to create examples that place one group of people over
  another (i.e. "Susan went to her project manager Tim..."). So as a more
  generalized rule, use examples that don't involve people.
- Follow other guidelines outlined in documents like the
  [Contributors Covenant](http://contributor-covenant.org/).

---

This is a living guide for myself and others as I learn more about writing
documentation. I hope it is helpful to others in its current state. If you have
any suggestions, feel free to open an issue or pull request on GitHub and let
me know.

Have fun writing!

---

[![cc-by-4.0](https://licensebuttons.net/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)


================================================
FILE: crowdin.yaml
================================================
project_identifier: documentation-handbook
api_key_env: CROWDIN_API_KEY
base_path: .
files:
  - source: '/README.md'
    translation: '/translations/%locale%/README.md'
    languages_mapping:
      locale:
        # 'af': 'af'
        # 'ar': 'ar'
        # 'ca': 'ca'
        # 'cs': 'cs'
        # 'da': 'da'
        # 'de': 'de'
        # 'el': 'el'
        # 'es-ES': 'es-ES'
        # 'fi': 'fi'
        # 'fr': 'fr'
        # 'he': 'he'
        # 'hu': 'hu'
        # 'it': 'it'
        # 'ja': 'ja'
        # 'ko': 'ko'
        # 'no': 'no'
        # 'nl': 'nl'
        # 'pl': 'pl'
        # 'pt-BR': 'pt-BR'
        # 'pt-PT': 'pt-PT'
        # 'ro': 'ro'
        'ru': 'ru'
        # 'sr': 'sr'
        # 'sv-SE': 'sv-SE'
        # 'tr': 'tr'
        # 'uk': 'uk'
        # 'vi': 'vi'
        # 'zh-CN': 'zh-Hans'
        # 'zh-TW': 'zh-Hant'


================================================
FILE: translations/ru/README.md
================================================
# Как писать качественную и понятную документацию, что бы люди хотели ее читать

## Переводы

<!-- - [English](/README.md)
<!-- - [Afrikaans](/translations/af/README.md) -->

<!-- - [العربية](/translations/ar/README.md) -->

<!-- - [Català](/translations/ca/README.md) -->

<!-- - [Čeština](/translations/cs/README.md) -->

<!-- - [Danske](/translations/da/README.md) -->

<!-- - [Deutsch](/translations/de/README.md) -->

<!-- - [ελληνικά](/translations/el/README.md) -->

<!-- - [Español](/translations/es-ES/README.md) -->

<!-- - [Suomi](/translations/fi/README.md) -->

<!-- - [Français](/translations/fr/README.md) -->

<!-- - [עִברִית](/translations/he/README.md) -->

<!-- - [Magyar](/translations/hu/README.md) -->

<!-- - [Italiano](/translations/it/README.md) -->

<!-- - [日本語](/translations/ja/README.md) -->

<!-- - [한국어](/translations/ko/README.md) -->

<!-- - [Norsk](/translations/no/README.md) -->

<!-- - [Nederlands](/translations/nl/README.md) -->

<!-- - [Português](/translations/pl/README.md) -->

<!-- - [Português (Brasil)](/translations/pt-BR/README.md) -->

<!-- - [Portugisisk](/translations/pt-PT/README.md) -->

<!-- - [Română](/translations/ro/README.md) --> - 

[Русский](/translations/ru/README.md) <!-- - [Српски језик (Ћирилица)](/translations/sr/README.md) -->

<!-- - [Svenska](/translations/sv-SE/README.md) -->

<!-- - [Türk](/translations/tr/README.md) -->

<!-- - [Український](/translations/uk/README.md) -->

<!-- - [Tiếng Việt](/translations/vi/README.md) -->

<!-- - [中文](/translations/zh-CN/README.md) -->

<!-- - [繁體中文](/translations/zh-TW/README.md) -->

**[Запросить другой перевод](https://github.com/thejameskyle/documentation-handbook/issues/new?title=Translation%20Request:%20[Please%20enter%20language%20here]&body=I%20am%20able%20to%20translate%20this%20language%20[yes/no])**

* * *

За последние несколько лет я написал много документации для таких проектов как Babel или Flow, записей в блоге и руководств вроде этих:

- https://github.com/thejameskyle/the-super-tiny-compiler
- https://github.com/thejameskyle/itsy-bitsy-data-structures
- https://github.com/thejameskyle/babel-handbook

В процессе написания я старался сосредоточиться на том, чтобы сделать это более доступным и более полезным для каждого. За эти годы я узнал много того, что делает, как мне кажется, документацию качественной и понятной.

> **Примечание:** Некоторые из этих советов действительно применимы, только когда идет речь о чем-то, что требует тонны документации. Попробуйте лучше адаптировать этот совет к тому, над чем вы работаете.

Вот они в виде этого большого списка:

#### В общем...

- Держитесь спокойного дружелюбного тона. Не тратьте время, доказывая, насколько вы умны. Отнеситесь к читателю как с близкому другу, который не очень разбирается в теме, но очень заинтересован.
- Не рассчитывайте, что многие будут уже "в теме". Если вы хотите обратиться к широкой аудитории (т.е. это не научно-исследовательская работа), то в этом случае будут люди с очень разным уровнем осведомленности.
- Не используйте такие слова, как "очевидно" или "в основном", более чем уверен, что это совсем *не нужно*. Просто говорите то, что нужно сказать простым и понятным языком. Никогда не ставьте себя выше читателя (а эта интонация имеется в этих словах).
- Не используйте идиомы. Выражайтесь используя более формальные термины, которые четко определены. Это будет проще для не носителей английского языка и для переводов, которые будут написаны. Если вы будете так делать, это будет не просто хорошо, а очень хорошо.
- Используйте слова, которые легче понять и перевести. Не волнуйтесь быть чуть многословней для более точного определения, подумайте о том, как это будет звучать для того, кто не знаком с этой темой.
- Излагайте кратко. Избегайте огромных параграфов, разбивая их на несколько с четким смыслом в каждом. Если вы пишете очень длинные параграфы, то это не лучший способ донести то, что вы имеете в виду.
- Чаще ссылайтесь на другие места в документации, ***но*** только для дополнительной информации. Читатели не должны листать по несколько страниц, чтобы найти информацию, которая им нужна только лишь о чем-то конкретном. Просто допишите соответствующую информацию и добавьте ссылку, если они захотят, чтобы узнать больше.
- Ограничьтесь небольшим числом примеров и используйте их как можно больше, разбирайте в примерах одну и ту же задачу и старайтесь основываться на этом. Не заставляйте пользователя думать о новых вопросах, людям это может мешать сфокусироваться. Если вам приходится придумывать новые примеры, возможно вы начали не с того места, вернитесь назад и придумайте что-то получше.

#### В процессе написания руководств...

- Используйте как можно больше примеров кода и консольных команд и т. п., *четко покажите* читателю, что вы имеете в виду. Эти примеры делают документацию намного легче для перевода и, по большей части, намного понятней, чем сотни страниц текста. Даже если вы не собираетесь этот код обсуждать, то это будет проще для понимания сути дела.
- Чаще используйте заголовки. Это помогает сосредоточиться в процессе чтения и в большинстве случаев помогает ссылаться к нужному разделу в документации.
- Если результате документация выходит на несколько страниц, подумайте о том, как одна страница ведет к другой, ведите пользователя от страницы к странице и старайтесь что бы это было последовательно.
- Сделайте плавное введение в руководстве перед погружением в технические детали. Это даст контекст и читатели, вероятно, будут больше заинтересованы и вовлечены.
- Поясняйте что-то один раз. Но вы можете заново объяснять одни и те же понятия с разных точек зрения или для различных сценариев использования.
- Не загромождайте объяснения чрезмерно подробными примерами. Не нужно писать игру Судоку и объяснять, как это сделать сделать с помощью вашей библиотеки. В общем, это все к тому, что не нужно вдаваться в детали объясняемого примера, так как это может отвлечь от самой темы.
- Не бойтесь абстрактных понятий (foo, bar). С их помощью можно не забивать голову лишним, это явно говорит читателю "не беспокойтесь том, что это такое, это может быть чем угодно".

#### В процессе написания документации на API...

- Думайте об документации на API, как о руководстве по его использованию. Типы ввода/вывода и расплывчатое описание - не достаточная информация для того, что бы быть полезной.
- Добавьте информацию, объясняющую назначение группы API, прежде чем погрузиться в их объяснение. Кроме того, добавьте любую другую соответствующую информацию или какие могут быть "подводные камни". С большой вероятностью, людям будет удобней читать в таком виде.
- Используйте общую терминологию в именах API, примерах и объяснениях. Называйте что-то одним и тем же именем, не зависимо от того, где вы на это ссылаетесь.
- Не пытайтесь решать задачи из реальной жизни в примерах кода, если эти задачи становятся сложнее чем API. Не реализуйте алгоритмы, не стоит засорять деталями реализации, которые не интересуют пользователя.
- Делайте примеры кода очень коротким. Ваша цель должна быть ~3-5 строк кода и каждая строка выше этого лимита играет против вас. Хорошо подумайте о примерах, которые вы используете.

#### Категорически...

- Никогда не используйте термины, которые являются оскорбительными для какой-либо группы людей. Это всегда не обосновано.
- Не следует использовать гендерные термины. Местоимения, такие как он/она/ее/его и терминология по половому признаку, как актриса/актер/официант/официантка должны быть полностью исключены, и вам следует избегать использования каких-либо терминов или фраз, которые могут и не иметь явного указания на пол, но могут иметь похожую смысловую нагрузку. Например, слова "милая", "аппетитная", "капризная" или "властная" все они имеют явную ссылку к женскому полу, а не к мужскому.
- Избегайте использования людей в качестве примеров. Вы, в конечном итоге, должны звучать, как будто вы говорите с детьми, ведь довольно легко создать примеры, которые ставят одну группу людей над другой (например, "Сьюзен пошла к своему менеджеру по проекту Тиму..."). Так, в качестве общего правила, используйте примеры, которые не связаны с людьми.
- Следуйте другим рекомендациям, изложенным в документации типа этой [Contributors Covenant](http://contributor-covenant.org/).

* * *

Это актуальное руководство лично для меня и других может дополняться по мере того, как я узнаю больше о написании документации. Надеюсь, что оно окажется полезным для других в его текущем состоянии. Если у вас есть какие-либо предложения, не стесняйтесь открыть issue или pull request на GitHub и дайте мне знать.

Пишите с удовольствием!

* * *

[![cc-by-4.0](https://licensebuttons.net/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)