Jadual Kandungan
回复内容:
Rumah pembangunan bahagian belakang tutorial php 请教下你们团队中有文档吗?哪些内容是需要专门的文档来记录的?

请教下你们团队中有文档吗?哪些内容是需要专门的文档来记录的?

Aug 29, 2016 am 08:50 AM
java php pengaturcara

在一个创业公司从零开始写程序一年多了,现在老板提出要文档化,要让新来的人也能快速上手项目,我不知道应该写哪些东西到文档里,可能写进去的过段时间后代码就被别的同事改了,文档就不对了,我要不要写文档,写什么,或者有更好的方式?

回复内容:

在一个创业公司从零开始写程序一年多了,现在老板提出要文档化,要让新来的人也能快速上手项目,我不知道应该写哪些东西到文档里,可能写进去的过段时间后代码就被别的同事改了,文档就不对了,我要不要写文档,写什么,或者有更好的方式?

  1. 代码修改记录

  2. 数据库修改记录

  3. 出现的问题,解决的办法

  4. 同事修改的话,要让同事更新到文档内容醉后面,别直接替换

我觉得首先交代一下公司项目的基本流程和规范比较好,比如新来的可能不一定知道公司之前的一些工作记录,搞不好做了重复工作和瞎折腾。可以先简单说明一下公司项目中用到的一些工具,框架,平台的基本介绍和相关链接;然后是公司编码规范,基本业务,工作计划(Todo),代码管理;然后是之前在工作过程中遇到的一些问题和解决方案,避免新人继续入坑;最后可以给新手推荐一下公司业务可能涉及需要去学习了解的技术栈。

php开源的DokuWiki

这本来就是一个坑,开发的时候没写现在写。
不过可以给些参考:
系统设计文档、数据库设计文档、接口设计文档、网站布署配置文档、网站使用说明文档等

Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

AI Hentai Generator

AI Hentai Generator

Menjana ai hentai secara percuma.

Artikel Panas

R.E.P.O. Kristal tenaga dijelaskan dan apa yang mereka lakukan (kristal kuning)
2 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Repo: Cara menghidupkan semula rakan sepasukan
4 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: Cara mendapatkan biji gergasi
3 minggu yang lalu By 尊渡假赌尊渡假赌尊渡假赌

Alat panas

Notepad++7.3.1

Notepad++7.3.1

Editor kod yang mudah digunakan dan percuma

SublimeText3 versi Cina

SublimeText3 versi Cina

Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1

Hantar Studio 13.0.1

Persekitaran pembangunan bersepadu PHP yang berkuasa

Dreamweaver CS6

Dreamweaver CS6

Alat pembangunan web visual

SublimeText3 versi Mac

SublimeText3 versi Mac

Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

Panduan Pemasangan dan Naik Taraf PHP 8.4 untuk Ubuntu dan Debian Panduan Pemasangan dan Naik Taraf PHP 8.4 untuk Ubuntu dan Debian Dec 24, 2024 pm 04:42 PM

Panduan Pemasangan dan Naik Taraf PHP 8.4 untuk Ubuntu dan Debian

Cara Menyediakan Kod Visual Studio (Kod VS) untuk Pembangunan PHP Cara Menyediakan Kod Visual Studio (Kod VS) untuk Pembangunan PHP Dec 20, 2024 am 11:31 AM

Cara Menyediakan Kod Visual Studio (Kod VS) untuk Pembangunan PHP

Bagaimana anda menghuraikan dan memproses HTML/XML dalam PHP? Bagaimana anda menghuraikan dan memproses HTML/XML dalam PHP? Feb 07, 2025 am 11:57 AM

Bagaimana anda menghuraikan dan memproses HTML/XML dalam PHP?

Cuti atau kembali dari Java 8 Stream Foreach? Cuti atau kembali dari Java 8 Stream Foreach? Feb 07, 2025 pm 12:09 PM

Cuti atau kembali dari Java 8 Stream Foreach?

Program PHP untuk mengira vokal dalam rentetan Program PHP untuk mengira vokal dalam rentetan Feb 07, 2025 pm 12:12 PM

Program PHP untuk mengira vokal dalam rentetan

Java Made Simple: Panduan Pemula untuk Kuasa Pengaturcaraan Java Made Simple: Panduan Pemula untuk Kuasa Pengaturcaraan Oct 11, 2024 pm 06:30 PM

Java Made Simple: Panduan Pemula untuk Kuasa Pengaturcaraan

Cipta Masa Depan: Pengaturcaraan Java untuk Pemula Mutlak Cipta Masa Depan: Pengaturcaraan Java untuk Pemula Mutlak Oct 13, 2024 pm 01:32 PM

Cipta Masa Depan: Pengaturcaraan Java untuk Pemula Mutlak

Program Java untuk mencari kelantangan kapsul Program Java untuk mencari kelantangan kapsul Feb 07, 2025 am 11:37 AM

Program Java untuk mencari kelantangan kapsul

See all articles