Kỹ thuật phần mềm documentation

20

Bạn có nên viết tài liệu tốt và mã sạch để tăng hệ số Bus Bus Factor không?

Một trong những mục tiêu chính của các công ty phát triển phần mềm là tăng yếu tố Bus của họ Điều này cũng được ủng hộ trong một cuộc nói chuyện được tổ chức bởi Google . Điều đó có nghĩa là bạn nên viết mã và ghi lại …

48 documentation clean-code

14

Điều gì có ác cảm với tài liệu trong ngành?

Dường như có ác cảm với việc viết ngay cả những tài liệu cơ bản nhất. READMEs dự án của chúng tôi là tương đối trần. Thậm chí không có danh sách phụ thuộc được cập nhật trong các tài liệu. Có điều gì đó tôi không biết trong ngành …

47 documentation teamwork

7

Làm thế nào để bạn theo dõi những lớp và chức năng mà nhóm của bạn đã viết?

Khi làm việc với mã, tôi phải đối mặt với nhiều thử thách giống như các đồng đội của mình và tôi đã viết một số hàm và lớp hữu ích, và chúng cũng vậy. Nếu có sự giao tiếp tốt, tôi sẽ nghe về một điều tuyệt vời mà …

43 documentation teamwork team code-reuse

6

Cúc I, Voi, chúng tôi, hoặc cả trong tài liệu mã

Tôi thấy mình viết (hy vọng) các bình luận hữu ích trong tài liệu mã (C ++) thuộc loại: The reason we are doing this is... Lý do tôi sử dụng "chúng tôi" thay vì "tôi" là vì tôi viết nhiều bài học thuật trong đó "chúng tôi" thường được …

41 documentation

12

Tài liệu trong OOP nên tránh chỉ định liệu một get getter có hay không thực hiện bất kỳ tính toán nào?

Chương trình CS của trường tôi tránh mọi đề cập đến lập trình hướng đối tượng, vì vậy tôi đã tự mình đọc một số thứ để bổ sung cho nó - cụ thể là Xây dựng phần mềm hướng đối tượng của Bertrand Meyer. Meyer đưa ra quan điểm …

39 design object-oriented documentation performance

2

Sự khác biệt giữa thông số kỹ thuật và tài liệu thiết kế là gì?

Thông số kỹ thuật là gì? Có phải chúng giống như tài liệu thiết kế. Nếu không, sự khác biệt và một số ví dụ là gì?

38 documentation specifications

6

Định dạng bảng tính thân thiện với Git? [đóng cửa]

Chúng tôi đang cố gắng chuyển quy trình tài liệu dự án của chúng tôi từ Tài liệu Google sang một bộ kho Git tự lưu trữ. Tài liệu văn bản là Git thân thiện đủ, vì chúng ta thường không cần bất kỳ ưa thích định dạng, chúng tôi …

35 version-control documentation tools linux

9

Những người không CNTT có thể xử lý wiki không? [đóng cửa]

Công ty của tôi đang tìm cách cải thiện quản lý dữ liệu nghiên cứu thị trường của họ. Phong cách quản lý dữ liệu hiện tại: "Này Jimbo, bức ảnh WhatZit 2.0 của chúng ta đâu? "vâng tôi nhớ email đó về công ty đó từ anh chàng đó, …

35 documentation cms wiki

6

Phương pháp để ghi lại cơ sở mã hiện có

Tôi làm việc như một phần của một nhóm trên một ứng dụng hiện có không có tài liệu nội tuyến, cũng không có tài liệu kỹ thuật. Khi tôi đang làm việc với các báo cáo lỗi khác nhau trên ứng dụng, tôi đã tự viết một loại dấu …

35 documentation language-agnostic methodology

3

Những rào cản nào phải đối mặt với quá trình phát triển trong việc sử dụng các ngôn ngữ đánh dấu văn bản đơn giản trái ngược với, ví dụ: Microsoft Word? [đóng cửa]

Tôi hiện đang là nhân viên thực tập tại một nhà thầu chính phủ và đang có cảm giác (đáng ghét không thể tránh khỏi) rằng Word là tiêu chuẩn không chính thức trong quy trình phát triển phần mềm. Định dạng nhị phân của nó làm cho việc cộng …

33 development-process documentation

3

Nguồn gốc của hoàng tử Readme

Khi nào mọi người bắt đầu viết các tập tin Readme? Dường như khá nhiều chương trình có tệp này, bất kể định dạng. Có bất kỳ tài liệu sử dụng đầu tiên của tài liệu này?

32 documentation terminology history

2

Làm thế nào để làm tài liệu cho mã và tại sao phần mềm (thường) được ghi chép kém?

Có một số ví dụ tốt về mã tài liệu tốt ngoài kia, chẳng hạn như java api. Nhưng, rất nhiều mã trong các dự án công cộng như git và các dự án nội bộ của các công ty là tài liệu kém và không thân thiện với người …

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

5

Tài liệu thiết kế như một phần của Agile

Tại nơi làm việc của tôi, chúng tôi phải đối mặt với một thách thức trong việc "nhanh nhẹn" quá thường xuyên có nghĩa là "yêu cầu mơ hồ, tiêu chí chấp nhận xấu, chúc may mắn!" Chúng tôi đang cố gắng giải quyết điều đó, như một nỗ lực …

25 design agile documentation

4

Là BDD thực sự có thể ghi bởi những người không lập trình?

Phát triển dựa trên hành vi với cú pháp kịch bản biểu tượng của Cho-Khi-Sau đó, gần đây đã bị thổi phồng vì những ứng dụng có thể của nó như là một đối tượng ranh giới để đánh giá chức năng phần mềm. Tôi chắc chắn đồng ý rằng …

24 documentation bdd documentation-generation business-rules

7

Phát hành đầu tiên hoặc tài liệu đầu tiên?

Tôi đã làm việc trong một dự án vài năm nay và tôi bắt đầu thu thập được một cơ sở người dùng tốt. Tôi đã tạo một trang dự án với một số tài liệu cơ bản, nhưng nó thực sự không nhiều hơn một Câu hỏi thường gặp …

23 documentation

Câu hỏi được gắn thẻ «documentation»