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

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

48 documentation  clean-code 

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

47 documentation  teamwork 

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

43 documentation  teamwork  team  code-reuse 

Я вважаю, що пишу (сподіваюсь) корисні коментарі в кодовій (C ++) документації такого типу: The reason we are doing this is... Причина, що я використовую "ми" замість "я", полягає в тому, що я багато навчаюсь писати там, де "ми" часто віддають перевагу. Тож ось питання. Чи є вагомі причини віддати …

41 documentation 

Програма CS моєї школи уникає будь-якої згадки об'єктно-орієнтованого програмування, тому я читав самостійно читання, щоб доповнити його - конкретно, Об'єктно-орієнтована побудова програмного забезпечення Бертрана Мейєра. Мейєр неодноразово зазначає, що класи повинні приховувати якомога більше інформації про їх реалізацію, що має сенс. Зокрема, він неодноразово стверджує, що атрибути (тобто статичні, не …

39 design  object-oriented  documentation  performance 

Що таке технічні характеристики? Чи вони такі самі, як проектні документи. Якщо ні, то в чому різниця та деякі приклади?

38 documentation  specifications 

Ми намагаємось перенести наш проект проектної документації з Документів Google до набору власницьких сховищ Git. Текстові документи досить зручні для Git, оскільки нам зазвичай не потрібне фантазійне форматування, ми просто перетворимо все на, скажімо, мультимаркет із можливістю вбудувати LaTeX у складних випадках. Але електронні таблиці - це зовсім інша історія …

35 version-control  documentation  tools  linux 

Моя компанія прагне покращити управління даними маркетингових досліджень. Поточний стиль управління даними: "Ей, Джимбо, де ця картина нашого WhatZit 2.0? "так, я пам’ятаю той електронний лист про цю компанію від цього хлопця, дай кілька хвилин, щоб шукати мій Outlook" "у кого найновіша копія каталогу товарів Важливого конкурента? Моя - з …

35 documentation  cms  wiki 

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

35 documentation  language-agnostic  methodology 

На даний момент я стажувався у державного підрядника і відчуваю (прикро неминуче) відчуття, що Word є фактичним стандартом у процесі розробки програмного забезпечення. Її двійковий формат дуже важко співпрацювати з документами так, як я звик співпрацювати на основі коду. Використання простої розмітки тексту (з такими мовами, як LaTeX, Markdown, ReStructured …

33 development-process  documentation 

Коли люди почали писати файли Readme? Здається, що майже всі програми мають цей файл, незалежно від формату. Чи є документально підтверджене перше використання цього документа?

32 documentation  terminology  history 

Є кілька хороших прикладів добре задокументованого коду, наприклад, java api. Але багато коду в публічних проектах, таких як git та внутрішні проекти компаній, є погано задокументованими та не дуже привітними для новачків. У всіх моїх розробках програмного забезпечення мені довелося стикатися з погано задокументованим кодом. Я помітив наступні речі - …

26 programming-practices  development-process  documentation  source-code  sdlc 

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

25 design  agile  documentation 

Розвиток, керований поведінкою, з його емблематичним синтаксисом сценаріїв "Дано-Коли-Потім" останнім часом є досить розкритим щодо можливого його використання як граничного об'єкта для оцінки функціональності програмного забезпечення. Я, безумовно, погоджуюся, що Gherkin або будь-який сценарій визначення функцій, який ви надаєте перевагу, - це бізнес- читабельний DSL , який вже читається , …

24 documentation  bdd  documentation-generation  business-rules 

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

23 documentation