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

Мені дуже подобається дизайн мови програмування. Іноді я думаю, що мої мовні проекти та їх потенційні користувачі отримають користь від документа про всебічні стандарти. Я переглянув багато мовних стандартів, починаючи від дуже формальних (C ++) до досить неформальних (ECMAScript), але я не можу реально зрозуміти, як мені слід розбити речі …

16 programming-languages  documentation  standardization 

Я працюю над продуктом для клієнта, який повинен бути дійсним та відповідним призначенню. Він побудований на стеку LAMP (PHP / Cake), тому є ліцензії GPL, MIT, PHP, APACHE: ОСНОВА "ЯК Є", БЕЗ гарантій чи умов будь-якого виду, явних або явних, включаючи, без обмежень, будь-які гарантії або умови НАЗВА, НЕЗАКОНУВАННЯ, ПРОДАЖНІСТЬ …

15 licensing  documentation  specifications 

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

15 agile  scrum  documentation 

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

15 project-management  documentation  knowledge-management  knowledge-base 

Якщо JSON розшифровується як JavaScript Object Notation, то коли ви говорите об'єкт JSON, чи не справді ви говорите "Object Notation Object"? Чи сказати б "рядок JSON" було б правильніше? Або правильніше було б просто сказати JSON? (як у "Ці дві служби передають JSON між собою".)

15 documentation  grammar  json 

У мене є кілька запитань щодо написання специфікації, і вони: Коли ми пишемо специфікацію програмного забезпечення, під темою "Визначення вимог користувачів" ми повинні вказати лише "Функції" та "Обмеження"? Чи потрапляє "Користувацький інтерфейс" у "функції" чи "обмеження"? На які основні сфери (вимоги) програмне забезпечення може бути розбито (наприклад, інтерфейс користувача)?

15 documentation  requirements 

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

15 documentation 

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

15 programming-practices  documentation  coding-standards  standardization 

Я шукаю формат документації інформативного класу для моїх класів Entity, Business Logic та Access Access. Я знайшов два таких форматів з тут Формат 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: …

15 c#  documentation  comments 

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

14 documentation  domain-driven-design 

Нещодавно я натрапив на те, наскільки корисні незмінні об'єкти, і що, наприклад, якщо ви передаєте елементи конструктору, і ваш клас повинен бути незмінним, ви повинні скопіювати ці елементи, якщо вони самі по собі не змінюються. Для цього потрібно багато перевірки чи знань про мій проект, тому що якщо я маю …

14 java  documentation  immutability 

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

14 learning  python  interview  documentation 

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

14 documentation 

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

14 testing  documentation  acceptance-testing 

Наразі я використовую дві системи для написання кодової документації (використовую C ++): Документація про методи та членів класу додається поруч із кодом у форматі Doxygen. На сервері Doxygen запускається на джерелах, тому висновок можна побачити у веб-браузері Сторінки огляду (що описують набір класів, структуру програми, приклад коду, ...) додаються у …

13 documentation  documentation-generation  wiki