├── crowdin.yaml ├── CONTRIBUTING.md ├── README.md ├── translations └── ru │ └── README.md └── LICENSE /crowdin.yaml: -------------------------------------------------------------------------------- 1 | project_identifier: documentation-handbook 2 | api_key_env: CROWDIN_API_KEY 3 | base_path: . 4 | files: 5 | - source: '/README.md' 6 | translation: '/translations/%locale%/README.md' 7 | languages_mapping: 8 | locale: 9 | # 'af': 'af' 10 | # 'ar': 'ar' 11 | # 'ca': 'ca' 12 | # 'cs': 'cs' 13 | # 'da': 'da' 14 | # 'de': 'de' 15 | # 'el': 'el' 16 | # 'es-ES': 'es-ES' 17 | # 'fi': 'fi' 18 | # 'fr': 'fr' 19 | # 'he': 'he' 20 | # 'hu': 'hu' 21 | # 'it': 'it' 22 | # 'ja': 'ja' 23 | # 'ko': 'ko' 24 | # 'no': 'no' 25 | # 'nl': 'nl' 26 | # 'pl': 'pl' 27 | # 'pt-BR': 'pt-BR' 28 | # 'pt-PT': 'pt-PT' 29 | # 'ro': 'ro' 30 | 'ru': 'ru' 31 | # 'sr': 'sr' 32 | # 'sv-SE': 'sv-SE' 33 | # 'tr': 'tr' 34 | # 'uk': 'uk' 35 | # 'vi': 'vi' 36 | # 'zh-CN': 'zh-Hans' 37 | # 'zh-TW': 'zh-Hant' 38 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## Translations 4 | 5 | The English translation of this repo is maintained in this repository, for 6 | other translations we use [Crowdin](https://crowdin.com/), if you would like to 7 | contribute to one of the translations you can invite yourself to the Crowdin 8 | Project [here](https://crowdin.com/project/documentation-handbook/invite). 9 | 10 | Changes to the English translation will automatically be sent to Crowdin which 11 | will notify translators of changes. When translations are completed, they will be 12 | built and sent back to GitHub. There's a short delay, but if any part of this 13 | process does not happen, please open an issue. 14 | 15 | Once you set up your account on Crowdin you should be taken to 16 | [this page](https://crowdin.com/project/documentation-handbook). 17 | 18 | Click on the language you would like to contribute to and then click on 19 | "README.md". You will be taken to the translation editor. 20 | 21 | ![Crowdin Translation Editor](https://cloud.githubusercontent.com/assets/952783/12076790/291e6cac-b170-11e5-989e-4cb2925e2b38.png) 22 | 23 | On the left side you can see the handbook. In red are missing translations, 24 | light green are translated, and dark green are translated and verified. 25 | 26 | If you click on one of the sections, it will bring it up in the center panel 27 | where you can enter a translation and save it. 28 | 29 | If you click on a section with text formatting or links, Crowdin has a special 30 | syntax for matching up the formatting. 31 | 32 | ![Crowdin translation format](https://cloud.githubusercontent.com/assets/952783/12076803/c1a83a52-b170-11e5-9925-329b129be959.png) 33 | 34 | If you match the numbered `<0>...` delimiters, Crowdin will build the final 35 | translation with all the formatting and links of the original. 36 | 37 | Once a translation is finished, it should only be a few minutes before the 38 | changes get pushed to GitHub automatically. 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # How to write high quality friendly documentation that people want to read 2 | 3 | ## Translations 4 | 5 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | - [Pусский](/translations/ru/README.md) 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | **[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])** 37 | 38 | --- 39 | 40 | For the last few years I have written a lot of documentation for projects like 41 | Babel or Flow, blog posts, and guides such as these: 42 | 43 | - https://github.com/thejameskyle/the-super-tiny-compiler 44 | - https://github.com/thejameskyle/itsy-bitsy-data-structures 45 | - https://github.com/thejameskyle/babel-handbook 46 | 47 | I've tried to focus on the way that I write in order to make it more 48 | approachable and more useful to everyone. There are a number of things that I 49 | have learned over the years that I believe makes for high-quality and friendly 50 | documentation. 51 | 52 | > **Note:** Some of this only really applies when you are talking about things 53 | > that require tons of documentation. Try to adapt this advice to fit what you 54 | > are working on best. 55 | 56 | Here they are as one massive list: 57 | 58 | #### In general... 59 | 60 | - Keep a lighthearted friendly tone. Don't spend time trying to prove how smart 61 | you are. Treat the reader as a close friend who doesn't have a lot of 62 | knowledge about the topic but is very interested. 63 | - Don't assume prior knowledge about the topic. If you want to appeal to a 64 | large audience (i.e. not a research paper) then you are going to have people 65 | with very diverse backgrounds. 66 | - Don't use words like "obviously" or "basically", I promise you will never 67 | *need* to. Just say what needs to be said in simple straight forward 68 | language. Never ever talk down to people (both of those words do, as well as 69 | others). 70 | - Don't use idioms. Speak using more formal terms that are well defined. This 71 | makes it easier for non-native-english speakers and for translations to be 72 | written. If you do, you won't just knock it out of the park, you'll do a 73 | really good job. 74 | - Use words that are easier to understand and translate (i.e. "list" instead 75 | of "enumerate"). Don't worry that you're being slightly more precise using a 76 | bigger word, think about how it will sound to someone unfamiliar with the 77 | topic. 78 | - Keep things brief. Avoid giant paragraphs, breaking them apart into multiple 79 | paragraphs each with a clear point. If you are writing really long 80 | paragraphs, it's most likely that you aren't doing a good job explaining what 81 | you mean. 82 | - Link to other places in the documentation often ***but*** only for additional 83 | information. Readers should not have to navigate through several pages to 84 | find the information that they need about one specific thing. Just inline the 85 | immediately relevant information and link off if they want to know more. 86 | - Reuse the same small set of examples as much as possible, keep presenting the 87 | same problem and building on top of it. Don't make the user keep thinking 88 | about new problems, people can only focus on so many things. If you need to 89 | keep coming up with new examples, you haven't started in a good place, start 90 | over and come up with a better one. 91 | 92 | #### When writing guides... 93 | 94 | - Use as many code/cli/etc examples as possible, *show* the reader what you 95 | mean. This makes things far easier to translate and is generally much easier 96 | to follow than walls of text. Even if you aren't going to discuss the code 97 | directly it's good for giving context. 98 | - Use headings frequently. This breaks things up when reading and often it is 99 | good for linking to specific information. 100 | - If writing with multiple pages, think about how a single page leads into the 101 | next, point the user to the next page and make sure it follows naturally. 102 | - Gently introduce a guide before diving into technical details. This gives 103 | context and readers are more likely to stay engaged longer. 104 | - Tell one story at a time. You can re-explain the same concepts from different 105 | perspectives or for different use-cases. 106 | - Don't clutter explanations with overly detailed examples. You don't need to 107 | implement a game of sudoku to explain how you might use your library with it. 108 | Typically if you have to explain the backstory of an example then it is too 109 | complicated and serves as a distraction from what you're teaching. 110 | - Don't be afraid of foo's and and bar's. Using them removes mental overhead, 111 | it's explicitly saying to the reader "don't worry about what this is, is 112 | could be anything" 113 | 114 | #### When writing api documentation... 115 | 116 | - Think about API docs like they are guides on how to use them. Type signatures 117 | for input and output and a vague description isn't enough to be useful. 118 | - Add information explaining the purpose of a group of APIs before diving into 119 | them. Also add any other relevant information or caveats. People are far more 120 | likely to read it this way. 121 | - Use shared terminology with API names, examples, and explanations. Call 122 | something a single name no matter where you are referring to it, and name 123 | things 124 | - Don't try to solve real world scenarios in code examples if they become any 125 | more complicated than the API already is. Do not implement algorithms, do not 126 | add a bunch of noisy implementation details that doesn't aid the user. 127 | - Keep code examples extremely short. Your target should be ~3-5 lines of code, 128 | every line past that is a count against you. Think hard about the examples 129 | you are using. 130 | 131 | #### Absolutely... 132 | 133 | - Never use terms that are offensive to any group. There will never be a good 134 | reason to. 135 | - Do not use gendered terms. Pronouns like he/she/her/him and gendered terms 136 | like actress/actor/waiter/waitress should all be thrown out and you should 137 | avoid using any terms or phrases that don't necessary refer directly to 138 | gender but have gendered connotations. For example, words "pretty", "curvy", 139 | "moody", or "bossy" all refer to women far more often than they do men. 140 | - Avoid examples using people. You end up sounding like you're talking to 141 | children and it's easy to create examples that place one group of people over 142 | another (i.e. "Susan went to her project manager Tim..."). So as a more 143 | generalized rule, use examples that don't involve people. 144 | - Follow other guidelines outlined in documents like the 145 | [Contributors Covenant](http://contributor-covenant.org/). 146 | 147 | --- 148 | 149 | This is a living guide for myself and others as I learn more about writing 150 | documentation. I hope it is helpful to others in its current state. If you have 151 | any suggestions, feel free to open an issue or pull request on GitHub and let 152 | me know. 153 | 154 | Have fun writing! 155 | 156 | --- 157 | 158 | [![cc-by-4.0](https://licensebuttons.net/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/) 159 | -------------------------------------------------------------------------------- /translations/ru/README.md: -------------------------------------------------------------------------------- 1 | # Как писать качественную и понятную документацию, что бы люди хотели ее читать 2 | 3 | ## Переводы 4 | 5 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | - 47 | 48 | [Русский](/translations/ru/README.md) 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | **[Запросить другой перевод](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])** 63 | 64 | * * * 65 | 66 | За последние несколько лет я написал много документации для таких проектов как Babel или Flow, записей в блоге и руководств вроде этих: 67 | 68 | - https://github.com/thejameskyle/the-super-tiny-compiler 69 | - https://github.com/thejameskyle/itsy-bitsy-data-structures 70 | - https://github.com/thejameskyle/babel-handbook 71 | 72 | В процессе написания я старался сосредоточиться на том, чтобы сделать это более доступным и более полезным для каждого. За эти годы я узнал много того, что делает, как мне кажется, документацию качественной и понятной. 73 | 74 | > **Примечание:** Некоторые из этих советов действительно применимы, только когда идет речь о чем-то, что требует тонны документации. Попробуйте лучше адаптировать этот совет к тому, над чем вы работаете. 75 | 76 | Вот они в виде этого большого списка: 77 | 78 | #### В общем... 79 | 80 | - Держитесь спокойного дружелюбного тона. Не тратьте время, доказывая, насколько вы умны. Отнеситесь к читателю как с близкому другу, который не очень разбирается в теме, но очень заинтересован. 81 | - Не рассчитывайте, что многие будут уже "в теме". Если вы хотите обратиться к широкой аудитории (т.е. это не научно-исследовательская работа), то в этом случае будут люди с очень разным уровнем осведомленности. 82 | - Не используйте такие слова, как "очевидно" или "в основном", более чем уверен, что это совсем *не нужно*. Просто говорите то, что нужно сказать простым и понятным языком. Никогда не ставьте себя выше читателя (а эта интонация имеется в этих словах). 83 | - Не используйте идиомы. Выражайтесь используя более формальные термины, которые четко определены. Это будет проще для не носителей английского языка и для переводов, которые будут написаны. Если вы будете так делать, это будет не просто хорошо, а очень хорошо. 84 | - Используйте слова, которые легче понять и перевести. Не волнуйтесь быть чуть многословней для более точного определения, подумайте о том, как это будет звучать для того, кто не знаком с этой темой. 85 | - Излагайте кратко. Избегайте огромных параграфов, разбивая их на несколько с четким смыслом в каждом. Если вы пишете очень длинные параграфы, то это не лучший способ донести то, что вы имеете в виду. 86 | - Чаще ссылайтесь на другие места в документации, ***но*** только для дополнительной информации. Читатели не должны листать по несколько страниц, чтобы найти информацию, которая им нужна только лишь о чем-то конкретном. Просто допишите соответствующую информацию и добавьте ссылку, если они захотят, чтобы узнать больше. 87 | - Ограничьтесь небольшим числом примеров и используйте их как можно больше, разбирайте в примерах одну и ту же задачу и старайтесь основываться на этом. Не заставляйте пользователя думать о новых вопросах, людям это может мешать сфокусироваться. Если вам приходится придумывать новые примеры, возможно вы начали не с того места, вернитесь назад и придумайте что-то получше. 88 | 89 | #### В процессе написания руководств... 90 | 91 | - Используйте как можно больше примеров кода и консольных команд и т. п., *четко покажите* читателю, что вы имеете в виду. Эти примеры делают документацию намного легче для перевода и, по большей части, намного понятней, чем сотни страниц текста. Даже если вы не собираетесь этот код обсуждать, то это будет проще для понимания сути дела. 92 | - Чаще используйте заголовки. Это помогает сосредоточиться в процессе чтения и в большинстве случаев помогает ссылаться к нужному разделу в документации. 93 | - Если результате документация выходит на несколько страниц, подумайте о том, как одна страница ведет к другой, ведите пользователя от страницы к странице и старайтесь что бы это было последовательно. 94 | - Сделайте плавное введение в руководстве перед погружением в технические детали. Это даст контекст и читатели, вероятно, будут больше заинтересованы и вовлечены. 95 | - Поясняйте что-то один раз. Но вы можете заново объяснять одни и те же понятия с разных точек зрения или для различных сценариев использования. 96 | - Не загромождайте объяснения чрезмерно подробными примерами. Не нужно писать игру Судоку и объяснять, как это сделать сделать с помощью вашей библиотеки. В общем, это все к тому, что не нужно вдаваться в детали объясняемого примера, так как это может отвлечь от самой темы. 97 | - Не бойтесь абстрактных понятий (foo, bar). С их помощью можно не забивать голову лишним, это явно говорит читателю "не беспокойтесь том, что это такое, это может быть чем угодно". 98 | 99 | #### В процессе написания документации на API... 100 | 101 | - Думайте об документации на API, как о руководстве по его использованию. Типы ввода/вывода и расплывчатое описание - не достаточная информация для того, что бы быть полезной. 102 | - Добавьте информацию, объясняющую назначение группы API, прежде чем погрузиться в их объяснение. Кроме того, добавьте любую другую соответствующую информацию или какие могут быть "подводные камни". С большой вероятностью, людям будет удобней читать в таком виде. 103 | - Используйте общую терминологию в именах API, примерах и объяснениях. Называйте что-то одним и тем же именем, не зависимо от того, где вы на это ссылаетесь. 104 | - Не пытайтесь решать задачи из реальной жизни в примерах кода, если эти задачи становятся сложнее чем API. Не реализуйте алгоритмы, не стоит засорять деталями реализации, которые не интересуют пользователя. 105 | - Делайте примеры кода очень коротким. Ваша цель должна быть ~3-5 строк кода и каждая строка выше этого лимита играет против вас. Хорошо подумайте о примерах, которые вы используете. 106 | 107 | #### Категорически... 108 | 109 | - Никогда не используйте термины, которые являются оскорбительными для какой-либо группы людей. Это всегда не обосновано. 110 | - Не следует использовать гендерные термины. Местоимения, такие как он/она/ее/его и терминология по половому признаку, как актриса/актер/официант/официантка должны быть полностью исключены, и вам следует избегать использования каких-либо терминов или фраз, которые могут и не иметь явного указания на пол, но могут иметь похожую смысловую нагрузку. Например, слова "милая", "аппетитная", "капризная" или "властная" все они имеют явную ссылку к женскому полу, а не к мужскому. 111 | - Избегайте использования людей в качестве примеров. Вы, в конечном итоге, должны звучать, как будто вы говорите с детьми, ведь довольно легко создать примеры, которые ставят одну группу людей над другой (например, "Сьюзен пошла к своему менеджеру по проекту Тиму..."). Так, в качестве общего правила, используйте примеры, которые не связаны с людьми. 112 | - Следуйте другим рекомендациям, изложенным в документации типа этой [Contributors Covenant](http://contributor-covenant.org/). 113 | 114 | * * * 115 | 116 | Это актуальное руководство лично для меня и других может дополняться по мере того, как я узнаю больше о написании документации. Надеюсь, что оно окажется полезным для других в его текущем состоянии. Если у вас есть какие-либо предложения, не стесняйтесь открыть issue или pull request на GitHub и дайте мне знать. 117 | 118 | Пишите с удовольствием! 119 | 120 | * * * 121 | 122 | [![cc-by-4.0](https://licensebuttons.net/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Attribution 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More_considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution 4.0 International Public License 58 | 59 | By exercising the Licensed Rights (defined below), You accept and agree 60 | to be bound by the terms and conditions of this Creative Commons 61 | Attribution 4.0 International Public License ("Public License"). To the 62 | extent this Public License may be interpreted as a contract, You are 63 | granted the Licensed Rights in consideration of Your acceptance of 64 | these terms and conditions, and the Licensor grants You such rights in 65 | consideration of benefits the Licensor receives from making the 66 | Licensed Material available under these terms and conditions. 67 | 68 | 69 | Section 1 -- Definitions. 70 | 71 | a. Adapted Material means material subject to Copyright and Similar 72 | Rights that is derived from or based upon the Licensed Material 73 | and in which the Licensed Material is translated, altered, 74 | arranged, transformed, or otherwise modified in a manner requiring 75 | permission under the Copyright and Similar Rights held by the 76 | Licensor. For purposes of this Public License, where the Licensed 77 | Material is a musical work, performance, or sound recording, 78 | Adapted Material is always produced where the Licensed Material is 79 | synched in timed relation with a moving image. 80 | 81 | b. Adapter's License means the license You apply to Your Copyright 82 | and Similar Rights in Your contributions to Adapted Material in 83 | accordance with the terms and conditions of this Public License. 84 | 85 | c. Copyright and Similar Rights means copyright and/or similar rights 86 | closely related to copyright including, without limitation, 87 | performance, broadcast, sound recording, and Sui Generis Database 88 | Rights, without regard to how the rights are labeled or 89 | categorized. For purposes of this Public License, the rights 90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 91 | Rights. 92 | 93 | d. Effective Technological Measures means those measures that, in the 94 | absence of proper authority, may not be circumvented under laws 95 | fulfilling obligations under Article 11 of the WIPO Copyright 96 | Treaty adopted on December 20, 1996, and/or similar international 97 | agreements. 98 | 99 | e. Exceptions and Limitations means fair use, fair dealing, and/or 100 | any other exception or limitation to Copyright and Similar Rights 101 | that applies to Your use of the Licensed Material. 102 | 103 | f. Licensed Material means the artistic or literary work, database, 104 | or other material to which the Licensor applied this Public 105 | License. 106 | 107 | g. Licensed Rights means the rights granted to You subject to the 108 | terms and conditions of this Public License, which are limited to 109 | all Copyright and Similar Rights that apply to Your use of the 110 | Licensed Material and that the Licensor has authority to license. 111 | 112 | h. Licensor means the individual(s) or entity(ies) granting rights 113 | under this Public License. 114 | 115 | i. Share means to provide material to the public by any means or 116 | process that requires permission under the Licensed Rights, such 117 | as reproduction, public display, public performance, distribution, 118 | dissemination, communication, or importation, and to make material 119 | available to the public including in ways that members of the 120 | public may access the material from a place and at a time 121 | individually chosen by them. 122 | 123 | j. Sui Generis Database Rights means rights other than copyright 124 | resulting from Directive 96/9/EC of the European Parliament and of 125 | the Council of 11 March 1996 on the legal protection of databases, 126 | as amended and/or succeeded, as well as other essentially 127 | equivalent rights anywhere in the world. 128 | 129 | k. You means the individual or entity exercising the Licensed Rights 130 | under this Public License. Your has a corresponding meaning. 131 | 132 | 133 | Section 2 -- Scope. 134 | 135 | a. License grant. 136 | 137 | 1. Subject to the terms and conditions of this Public License, 138 | the Licensor hereby grants You a worldwide, royalty-free, 139 | non-sublicensable, non-exclusive, irrevocable license to 140 | exercise the Licensed Rights in the Licensed Material to: 141 | 142 | a. reproduce and Share the Licensed Material, in whole or 143 | in part; and 144 | 145 | b. produce, reproduce, and Share Adapted Material. 146 | 147 | 2. Exceptions and Limitations. For the avoidance of doubt, where 148 | Exceptions and Limitations apply to Your use, this Public 149 | License does not apply, and You do not need to comply with 150 | its terms and conditions. 151 | 152 | 3. Term. The term of this Public License is specified in Section 153 | 6(a). 154 | 155 | 4. Media and formats; technical modifications allowed. The 156 | Licensor authorizes You to exercise the Licensed Rights in 157 | all media and formats whether now known or hereafter created, 158 | and to make technical modifications necessary to do so. The 159 | Licensor waives and/or agrees not to assert any right or 160 | authority to forbid You from making technical modifications 161 | necessary to exercise the Licensed Rights, including 162 | technical modifications necessary to circumvent Effective 163 | Technological Measures. For purposes of this Public License, 164 | simply making modifications authorized by this Section 2(a) 165 | (4) never produces Adapted Material. 166 | 167 | 5. Downstream recipients. 168 | 169 | a. Offer from the Licensor -- Licensed Material. Every 170 | recipient of the Licensed Material automatically 171 | receives an offer from the Licensor to exercise the 172 | Licensed Rights under the terms and conditions of this 173 | Public License. 174 | 175 | b. No downstream restrictions. You may not offer or impose 176 | any additional or different terms or conditions on, or 177 | apply any Effective Technological Measures to, the 178 | Licensed Material if doing so restricts exercise of the 179 | Licensed Rights by any recipient of the Licensed 180 | Material. 181 | 182 | 6. No endorsement. Nothing in this Public License constitutes or 183 | may be construed as permission to assert or imply that You 184 | are, or that Your use of the Licensed Material is, connected 185 | with, or sponsored, endorsed, or granted official status by, 186 | the Licensor or others designated to receive attribution as 187 | provided in Section 3(a)(1)(A)(i). 188 | 189 | b. Other rights. 190 | 191 | 1. Moral rights, such as the right of integrity, are not 192 | licensed under this Public License, nor are publicity, 193 | privacy, and/or other similar personality rights; however, to 194 | the extent possible, the Licensor waives and/or agrees not to 195 | assert any such rights held by the Licensor to the limited 196 | extent necessary to allow You to exercise the Licensed 197 | Rights, but not otherwise. 198 | 199 | 2. Patent and trademark rights are not licensed under this 200 | Public License. 201 | 202 | 3. To the extent possible, the Licensor waives any right to 203 | collect royalties from You for the exercise of the Licensed 204 | Rights, whether directly or through a collecting society 205 | under any voluntary or waivable statutory or compulsory 206 | licensing scheme. In all other cases the Licensor expressly 207 | reserves any right to collect such royalties. 208 | 209 | 210 | Section 3 -- License Conditions. 211 | 212 | Your exercise of the Licensed Rights is expressly made subject to the 213 | following conditions. 214 | 215 | a. Attribution. 216 | 217 | 1. If You Share the Licensed Material (including in modified 218 | form), You must: 219 | 220 | a. retain the following if it is supplied by the Licensor 221 | with the Licensed Material: 222 | 223 | i. identification of the creator(s) of the Licensed 224 | Material and any others designated to receive 225 | attribution, in any reasonable manner requested by 226 | the Licensor (including by pseudonym if 227 | designated); 228 | 229 | ii. a copyright notice; 230 | 231 | iii. a notice that refers to this Public License; 232 | 233 | iv. a notice that refers to the disclaimer of 234 | warranties; 235 | 236 | v. a URI or hyperlink to the Licensed Material to the 237 | extent reasonably practicable; 238 | 239 | b. indicate if You modified the Licensed Material and 240 | retain an indication of any previous modifications; and 241 | 242 | c. indicate the Licensed Material is licensed under this 243 | Public License, and include the text of, or the URI or 244 | hyperlink to, this Public License. 245 | 246 | 2. You may satisfy the conditions in Section 3(a)(1) in any 247 | reasonable manner based on the medium, means, and context in 248 | which You Share the Licensed Material. For example, it may be 249 | reasonable to satisfy the conditions by providing a URI or 250 | hyperlink to a resource that includes the required 251 | information. 252 | 253 | 3. If requested by the Licensor, You must remove any of the 254 | information required by Section 3(a)(1)(A) to the extent 255 | reasonably practicable. 256 | 257 | 4. If You Share Adapted Material You produce, the Adapter's 258 | License You apply must not prevent recipients of the Adapted 259 | Material from complying with this Public License. 260 | 261 | 262 | Section 4 -- Sui Generis Database Rights. 263 | 264 | Where the Licensed Rights include Sui Generis Database Rights that 265 | apply to Your use of the Licensed Material: 266 | 267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 268 | to extract, reuse, reproduce, and Share all or a substantial 269 | portion of the contents of the database; 270 | 271 | b. if You include all or a substantial portion of the database 272 | contents in a database in which You have Sui Generis Database 273 | Rights, then the database in which You have Sui Generis Database 274 | Rights (but not its individual contents) is Adapted Material; and 275 | 276 | c. You must comply with the conditions in Section 3(a) if You Share 277 | all or a substantial portion of the contents of the database. 278 | 279 | For the avoidance of doubt, this Section 4 supplements and does not 280 | replace Your obligations under this Public License where the Licensed 281 | Rights include other Copyright and Similar Rights. 282 | 283 | 284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 285 | 286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 296 | 297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 306 | 307 | c. The disclaimer of warranties and limitation of liability provided 308 | above shall be interpreted in a manner that, to the extent 309 | possible, most closely approximates an absolute disclaimer and 310 | waiver of all liability. 311 | 312 | 313 | Section 6 -- Term and Termination. 314 | 315 | a. This Public License applies for the term of the Copyright and 316 | Similar Rights licensed here. However, if You fail to comply with 317 | this Public License, then Your rights under this Public License 318 | terminate automatically. 319 | 320 | b. Where Your right to use the Licensed Material has terminated under 321 | Section 6(a), it reinstates: 322 | 323 | 1. automatically as of the date the violation is cured, provided 324 | it is cured within 30 days of Your discovery of the 325 | violation; or 326 | 327 | 2. upon express reinstatement by the Licensor. 328 | 329 | For the avoidance of doubt, this Section 6(b) does not affect any 330 | right the Licensor may have to seek remedies for Your violations 331 | of this Public License. 332 | 333 | c. For the avoidance of doubt, the Licensor may also offer the 334 | Licensed Material under separate terms or conditions or stop 335 | distributing the Licensed Material at any time; however, doing so 336 | will not terminate this Public License. 337 | 338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 339 | License. 340 | 341 | 342 | Section 7 -- Other Terms and Conditions. 343 | 344 | a. The Licensor shall not be bound by any additional or different 345 | terms or conditions communicated by You unless expressly agreed. 346 | 347 | b. Any arrangements, understandings, or agreements regarding the 348 | Licensed Material not stated herein are separate from and 349 | independent of the terms and conditions of this Public License. 350 | 351 | 352 | Section 8 -- Interpretation. 353 | 354 | a. For the avoidance of doubt, this Public License does not, and 355 | shall not be interpreted to, reduce, limit, restrict, or impose 356 | conditions on any use of the Licensed Material that could lawfully 357 | be made without permission under this Public License. 358 | 359 | b. To the extent possible, if any provision of this Public License is 360 | deemed unenforceable, it shall be automatically reformed to the 361 | minimum extent necessary to make it enforceable. If the provision 362 | cannot be reformed, it shall be severed from this Public License 363 | without affecting the enforceability of the remaining terms and 364 | conditions. 365 | 366 | c. No term or condition of this Public License will be waived and no 367 | failure to comply consented to unless expressly agreed to by the 368 | Licensor. 369 | 370 | d. Nothing in this Public License constitutes or may be interpreted 371 | as a limitation upon, or waiver of, any privileges and immunities 372 | that apply to the Licensor or You, including from the legal 373 | processes of any jurisdiction or authority. 374 | 375 | 376 | ======================================================================= 377 | 378 | Creative Commons is not a party to its public licenses. 379 | Notwithstanding, Creative Commons may elect to apply one of its public 380 | licenses to material it publishes and in those instances will be 381 | considered the "Licensor." Except for the limited purpose of indicating 382 | that material is shared under a Creative Commons public license or as 383 | otherwise permitted by the Creative Commons policies published at 384 | creativecommons.org/policies, Creative Commons does not authorize the 385 | use of the trademark "Creative Commons" or any other trademark or logo 386 | of Creative Commons without its prior written consent including, 387 | without limitation, in connection with any unauthorized modifications 388 | to any of its public licenses or any other arrangements, 389 | understandings, or agreements concerning use of licensed material. For 390 | the avoidance of doubt, this paragraph does not form part of the public 391 | licenses. 392 | 393 | Creative Commons may be contacted at creativecommons.org. 394 | --------------------------------------------------------------------------------