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

Я (випадково) досліджував семантичні / онтологічні підходи до технічної документації, коли натрапляв на цей дорогоцінний камінь : Грамотне програмування та семантична веб - це ідеї різних часів, які мають зв’язок. Пов'язаний документ, грамотне програмування в XML Нормана Уолша, обговорює XML - технологію , які є ключовими для семантичної мережі, проте …

9 documentation  semantic-web  literate-programming 

Якщо у мене є фрагмент коду, який є математично чи структурно досить складним і неприпустимим, то як би я пішов про документування цього фрагмента коду? Зокрема, як я можу забезпечити, щоб хтось, хто може не мати математичних чи архітектурних навичок, які я, зрозумів це з документації? Чи повинен я також …

9 documentation 

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

9 documentation  design  modeling 

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

9 documentation 

Я хочу написати Javadoc сухим способом. Але в документі Oracle про Javadoc сказано написати те саме, що в коментарі методу перевантаження Не можу я уникнути повторення?

9 documentation  comments  dry  javadocs 

Я приймаю свою першу заявку на рівні підприємства, і я хочу, щоб моя команда змоделювала всю програму ASP.NET MVC C #, перш ніж ми навіть використаємо один рядок коду. ОНОВЛЕННЯ: Це не було метою філософської дискусії про те, коли потрібно документувати / моделювати додаток. Будь ласка, надайте відповіді лише на …

9 c#  asp.net-mvc  documentation  uml 

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

9 project-management  documentation 

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

9 documentation  project-management  wiki  requirements 

Це може бути дурним питанням, але це вже деякий час у моїй голові, і я ніде більше не можу знайти гідної відповіді. У мене є вчитель, який каже, що ми повинні чітко перелічити кожен параметр з описом, навіть якщо є лише один. Це призводить до великої кількості повторень: double MyFunction(const …

9 documentation  comments  coding-style