Available translations
loading results
Iterating on Definitions
Summary: Once you finish the first draft of all Definition Pages, you must run it through developers to get their feedback.
Summary: После того как вы закончите первый проект всех страниц определений, вы должны прогнать его через разработчиков, чтобы получить их отзывы.
Summary: Sobald Sie den ersten Entwurf aller Definitionsseiten (Definition Pages) fertiggestellt haben, müssen Sie ihn den Entwicklern vorlegen, um deren Feedback einzuholen.
Pretty much like code, documentation is a living organism that must evolve to become great. It is highly unlikely that the first version of anything you write is the best possible version. The truth is that writing the definition pages is part of your learning process.
Как и код, документация - это живой организм, который должен развиваться, чтобы стать великим. Маловероятно, что первая версия всего, что вы напишете, будет лучшей из возможных версий. Правда в том, что написание страниц определения - это часть вашего процесса обучения.
Ähnlich wie der Code ist auch die Dokumentation ein lebender Organismus, der sich weiterentwickeln muss, um gut zu werden. Es ist höchst unwahrscheinlich, dass die erste Version von etwas, das Sie schreiben, die bestmögliche Version ist. Die Wahrheit ist, dass das Schreiben der Definitionsseiten Teil Ihres Lernprozesses ist.
The session you recorded with the devs will have made things clear enough for you to start writing. However, as you dive into the definition of each node, you will likely have questions or discover that there are details that you still don't grasp.
Сессия, которую вы записали с разработчиками, достаточно прояснила ситуацию, чтобы вы могли начать писать. Однако, когда вы погрузитесь в определение каждого узла, у вас, скорее всего, возникнут вопросы или вы обнаружите, что есть детали, которые вы все еще не поняли.
Die Sitzung, die Sie mit den Entwicklern aufgezeichnet haben, wird Ihnen genug Klarheit verschafft haben, um mit dem Schreiben zu beginnen. Wenn Sie jedoch in die Definition der einzelnen Knoten eintauchen, werden Sie wahrscheinlich Fragen haben oder feststellen, dass es Details gibt, die Sie noch nicht verstanden haben.
As soon as you finish the first draft of the definition pages of each node, you should ask the developers to go through the definitions and obtain their feedback. You may need to fix or improve a few definitions, or even do extensive rewrites. Rest assured this is to be expected, particularly if you're documenting a new project.
Как только вы закончите первый проект страниц определений каждого узла, вы должны попросить разработчиков просмотреть определения и получить их отзывы. Возможно, вам придется исправить или улучшить несколько определений, или даже переписать их. Будьте уверены, этого следует ожидать, особенно если вы документируете новый проект.
Sobald Sie den ersten Entwurf der Definitionsseiten eines jeden Knotens fertiggestellt haben, sollten Sie die Entwickler bitten, die Definitionen durchzugehen und ihr Feedback einzuholen. Es kann sein, dass Sie einige Definitionen korrigieren oder verbessern müssen, oder sogar umfangreiche Neufassungen vornehmen müssen. Seien Sie versichert, dass dies zu erwarten ist, insbesondere wenn Sie ein neues Projekt dokumentieren.
Important: It is of the utmost importance that you iterate on definitions until developers have nothing else to say about your write-up. Remember that these definitions will make up the better part of the overall documentation, so there's no point in rushing things to get to the next stage.
Important: Крайне важно, чтобы вы повторяли определения до тех пор, пока разработчикам больше нечего будет сказать о вашей документации. Помните, что эти определения составят большую часть всей документации, поэтому нет смысла торопиться, чтобы перейти к следующему этапу.
Important: Es ist von größter Wichtigkeit, dass Sie die Definitionen so lange wiederholen, bis die Entwickler nichts mehr zu Ihrem Beitrag sagen können. Denken Sie daran, dass diese Definitionen den größten Teil der gesamten Dokumentation ausmachen werden, es hat also keinen Sinn, die Dinge zu überstürzen, um zur nächsten Stufe zu gelangen.