Запитання з тегом «documentation»

Основною частиною дизайну, керованого доменом, є послідовне використання всюдисущої мови в системі - в розмовах, коді, схемі бази даних, інтерфейсі користувача, тестах тощо. Я беру участь у проекті, в якому вже є добре встановлена ​​мова домену, визначена міжнародною організацією зі стандартів. Однак робота, яку ми виконуємо, - це загальнодоступний веб-сайт, …

10 documentation  domain-specific-languages 

Мені здається, ви не можете написати специфікацію програмного забезпечення англійською мовою, яка повністю не містить двозначностей, просто через неофіційну природу природної мови - і тому справді однозначна специфікація повинна містити код, написаний на формально визначеній мові. Це відомий результат чи я щось пропускаю?

10 documentation  specifications 

Я один з тих розробників, який має розум, що написаний код повинен бути зрозумілим і читатись як книга. ЯКЩО, розробляючи код бібліотеки для інших людей, я намагаюся вмістити якомога більше документації у файли заголовків; що викликає питання: чи варто документувати методи, які є непублічними, навіть варті часу? Вони не будуть …

10 c++  documentation 

Важко сказати, про що тут питають. Це запитання є неоднозначним, розпливчастим, неповним, надто широким або риторичним і не може бути обґрунтовано відповісти в його теперішній формі. Для уточнення цього питання, щоб його можна було знову відкрити, відвідайте довідковий центр . Закрито 8 років тому . Мені подобаються невеликі ітерації. Мені …

10 agile  documentation  methodology 

Зачинено. Це питання поза темою . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно було тематичним для обміну стеками програмного забезпечення. Закрито 6 років тому . Наше власне програмне забезпечення використовується для багатьох користувачів, і навчальний відділ попросив нас отримати будь-які поради щодо формату документації для …

10 design  documentation  users 

Закрито . Це питання має бути більш зосередженим . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно зосередило увагу на одній проблемі, лише відредагувавши цю публікацію . Закрито 4 роки тому . Чому ми все ще вкладаємо описи вихідного коду на природній мові (тобто, чому було …

10 development-process  documentation  source-code 

Я задокументував свій код для doxygen, але я не хочу HTML, який він надає за замовчуванням. Я знаю, що можу налаштувати його, надаючи користувальницькі CSS, заголовки, колонтитули тощо (як це робить GNOME), і як я можу додати загальний код PHP до файлів і сказати, щоб він зберігав як .php, але …

10 documentation  templates  documentation-generation 

Мені цікаво, що повинна містити документація щодо алгоритму? Не вдається знайти правильну інструкцію, яку слід дотримуватися. Я маю на увазі включити підсумок алгоритму опис алгоритму блок-схеми псевдокоди вибірки набору вхідних даних (кілька) вихідні дані одиничні тести експерименти Клієнт просить таку документацію: Підтримувати довіру до власних номерів, а також описати наш …

10 java  php  algorithms  documentation  sql 

У нас є багато документів, пов'язаних з нашою розробкою програмного забезпечення. До них відносяться такі речі, як вимоги, конструкторські документи, зовнішні PDF-файли, файли клієнтів, інструкції з тестування тощо. Наразі ці документи розкидані по всьому світу (вікі, "якесь місце в мережі", жорсткий диск місцевих розробників (!), і ще гірші місця). Який …

10 version-control  documentation 

Переглядаючи реалізацію іншого програміста функції для обчислення нормального CDF розподілу , я запропонував або замінити всю реалізацію на вбудовані функції Python, або використовувати SciPy, загальну наукову бібліотеку. Інший програміст зазначив, що ні в жодних документах, math.erfc()ні scipy.stats.norm.cdf()в їх документації не передбачено жодних гарантій точності. Тому я повинен бути більш обережним …

9 documentation  math  floating-point  numeric-precision 

Часто я опиняюсь як вирішувати помилки, знаходячи відповідь на Stack Overflow. Чи погана практика додати фрагмент, чому я зробив те, що робив, а потім додати посилання на статтю чи сторінку з Інтернету?

9 documentation 

Я працюю над невеликою бібліотекою, яка забезпечує реалізацію основних, добре відомих рядкових показників. Переважно для моєї власної освіти. Тож розвиток відбувається коли-небудь у мене трохи вільного часу. Через це я автоматизував більшість процесів, тому я можу випускати версію так часто, як я працюю над нею без особливих зусиль. Однак підтримка …

9 java  documentation  javadocs 

Це стосується дискусії у відповіді та коментарів до цього питання: Що з відразою до документації в галузі? . У відповіді стверджувалося, що "код не може лежати", і, таким чином, він повинен бути місцем переходу до документації, а не документацією. У кількох коментарях зазначалося, що "код може брехати". Існує правда з …

9 documentation 

Я збираюся залишити проект, і перед тим, як поїхати, мій начальник попросив мене документувати код (я не дуже добре документував). Це не велика справа, проект не страшно складний. Але я знаходжу місця в своїй документації, де я хотів би сказати: "Зауважте, на лінії XYZ, що таке і таке трапляється". У …

9 documentation  comments 

Мені цікаво подивитися, як це роблять інші люди. Особливо в ситуаціях, коли кілька різних клієнтів використовують одну і ту ж базу програмного забезпечення з дещо різними правилами бізнесу. Які практики ви використовуєте для документування того, як все повинно працювати чи правилами бізнесу. В основному так, коли новий розробник приходить в …

9 documentation  business-rules