💯О том, как писать цифры в технической документации
📌The style rules for numbers can vary, but the most important thing is to remain consistent throughout the document.
📌Generally, spell out numbers less than 10; write numbers 10 or greater as figures. This applies to both cardinal and ordinal (spell out first or fifth, but use 14th or 122nd)) numbers.
📌Some exceptions to the general rule include:
✔️Express time in figures: “11:30 a.m.; 4:00 p.m.”
✔️Do not begin a sentence with a figure: either spell out the number (however large), or rewrite the sentence so it does not begin with a number.
✔️Very large numbers are expressed in figures followed by the word million, billion, etc. For example: not 1,000,000,000, but 1 billion.
✔️Use figures for all percentages and decimals within a sentence: “A score of 3 percent was reached an average of 3.5 times.”
⏳Сделаем паузу в разговорах о технической документации.
🙅♀️Когда вы не можете выразить своё полное несогласие с собеседником, но и согласиться- никак, можно использовать следующие фразы, которые помогут продолжить вести диалог:
📜А есть ли среди нас те, кто пишут техническую документацию? Если да, то есть совет.
Когда вы написали предложение, посмотрите, нет ли в нем лишних слов 🧐Ключ к успеху- простота.
📌Примеры слов, которые стоит избегать:
♦ as you know ♦ at the present moment in time (replace with “now”) ♦ basically ♦ completely ♦ essentially ♦ extremely ♦ in order to (replace with “to”) ♦ in terms of ♦ it can be seen that ♦ it is interesting that ♦ it should be remembered that ♦ moreover ♦ quite ♦ totally ♦ utilize, utilization (replace with “use”) ♦ very
🙍🏼♀️🙎🏼♂️Не очень важное... только на первый взгляд.
Когда вы пишите любую техническую документацию, избегайте местоимений он/она. Вот что советуют эксперты:
📌No personal pronoun in English refers to both sexes. When discussing general categories of people, try to rewrite the sentence in the plural to avoid the issue of gender.
❌Instead of “A programmer would see the flaw in this logic. He would correct it immediately.”
✔️Use “Programmers would see the flaw in this logic. They would correct it immediately.”
🙍🏼♀️🙎🏼♂️Use gender-neutral nouns and pronouns:
chair instead of chairman their, they, or them rather than he, she, her, or him.
Почти на тему грядущего "праздника" пост получился😂
✔️We can minimize the risk of creating a useless product by observing and talking to people. Hence, uncovering the problem that customers really have is the key at the very beginning.
📌to tacke a problem- решить проблему
✔️Thinking in products makes sure designers tackle real user problems and herewith reduce the risk of building something nobody wants #UX_English
📜После постов о User Stories, нас спросили: "А что же надо знать об Acceptance criteria?". Ведь их же... больше, они должны быть четкими и понятными.
📌Есть User Story:
As a frequent book buyer I want strong passwords so that my credit card information remains secure.
✔️Для нее будет такой вот Acceptance criteria:
The password is at least 8 characters. The password contains a character from each of the following groups: Lower case alphabet, Upper case alphabet, Numbers Special Characters (!,@,#,$,%,^,&,*).
📌Цель Acceptance criteria- избежать многочтения User stories.
📌📌📌Они просты, Present Simple Active и Passive, модальные глаголы- то немногое, что используется в критериях.
✔️An acknowledgment email is sent to the customer submitting the form.
📌Можно еще такой вот сценарный метод использовать: Given/When/Then:
✔️Given I’m a logged-out system user and I’m on the Sign-In page When I fill in the “Username” and “Password” fields with my authentication credentials and I click the Sign-In button Then the system signs me in #Вопрос_от_студента
Если вам нужно добавить детали к As a < type of user >, I want < some goal > so that <some reason >, то вы можете разбить стори на несколько или добавлять детали к этой.
📌Добавить детали можно с помощью конструкции "BY+ VERB+ING"
✔️As an administrator, I want to invite estimators by giving them a url where they can access the game so that we can start the game
✔️As an estimator, I want to start a round by entering an item in a single multi-line text field, so that we can estimate