あなたのチームに文書はありますか?記録するために特別な文書が必要なコンテンツは何ですか?

私はスタートアップ企業で 1 年以上、ゼロからプログラムを書いてきました。今、上司が、新人がプロジェクトをすぐに始められるように、それを文書化したいと考えています。文書に何を書けばよいのかわかりません。しばらくすると、他の同僚によってコードが変更され、ドキュメントが間違っていました。それとも、もっと良い方法があるでしょうか?

返信内容:

私はスタートアップ企業で 1 年以上、ゼロからプログラムを書いてきました。今、上司が、新人がプロジェクトをすぐに始められるように、それを文書化したいと考えています。文書に何を書けばよいのかわかりません。しばらくすると、他の同僚によってコードが変更され、ドキュメントが間違っていました。それとも、もっと良い方法があるでしょうか?

1. コード修正記録

2. データベース変更記録

3. 問題と解決策

4. 同僚が変更を加えた場合は、文書を直接置き換えるのではなく、文書の最後まで更新するように依頼してください

最初に会社のプロジェクトの基本的なプロセスや仕様を説明した方がよいと思います。たとえば、新人は会社のこれまでの作業実績を必ずしも知っているとは限らず、作業が重複したり混乱したりする可能性があります。まず、会社のプロジェクトで使用されているいくつかのツール、フレームワーク、プラットフォームの基本的な紹介と関連リンクを簡単に説明し、次に会社のコーディング標準、基本的なビジネス、作業計画 (Todo)、およびコード管理中に発生した問題について説明します。初心者が罠に陥り続けることを防ぐために、いくつかの問題と解決策について言及します。最後に、会社のビジネスに関係する可能性があり、学ぶ必要があるいくつかのテクノロジースタックを初心者に推奨できます。

php オープンソース DokuWiki

これはもともと開発中に書かなかった落とし穴だったので、今書いています。
しかし、いくつかの参考資料を提供することはできます:
システム設計文書、データベース設計文書、インターフェース設計文書、Web サイト展開構成文書、Web サイト使用説明書など