skillup

技術ブログ

「 ドキュメント作成 」 一覧

no image

Gitの活用に関して

2021/01/02   -Git, ドキュメント作成

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。 ブランチを追加機能ごとにきる 当たり前ですが、featur …

no image

単体テスト仕様書について

おそらく開発者が書きたくないものの筆頭になるかと思う単体テスト仕様書ですが、うまく使うと有益なコミニケーションツールになります。 ユーザーのフロー体験・説明書 プロジェクトに入ったばかりですと仕様がわ …

no image

Officeソフトで覚えておきたいポイント(Word,Excel)

えー実は今現在、仕事でコードを書くことはほとんどしておらず、ExcelやWordと日々格闘しております。Excelも表計算じゃなくて図を書くのに使ってます。 ExcelはまだしもWordってエンジニア …

no image

仕様の把握で見るポイント

新しい現場に入って技術的な部分はもとより仕様の把握などでポイントになる点などを。 ER図 あればまずそのER図を使えば良いですし、なければ作っていくと理解が進むことが多いです。 ポイントとしては意味の …

no image

使える設計書作成に関して シーケンス図

使える仕様書ですが、細かいロジックなどシーケンス図も結構役に立つのでは・・と思いましたね。 シーケンス図とは下記のようなものです。 https://cacoo.com/ja/blog/what-is- …

no image

使える設計書作成に関して

私自身、この仕事を7〜8年やっておりますが、設計書作成については常に悩まされておりました。 設計書のメリット・デメリットとしては以下のようなものですかね。 メリット メンバー間での仕様の認識を統一でき …

no image

新しいプロジェクトに入った時にやること

新しいプロジェクトに入った時に最初にすべきことややっておくことなど 仕様理解編 基本ですが、見落としがないように紙の資料は必ず印刷して考えること。文房具として消すことのできる色ペンがあるとさらに便利。 …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 仕様書はソースから web系のペースの早い現場とかだと …

no image

ER図作成ツールについて(Mac版)

ER図作成ツールについてMacで色々と調べましたので、メモを。 フリー限定で。 ちなみにwindowsを使っていればA5:SQLが一番使えるかと思います。 以前も下記リンクで説明させていただきました。 …

no image

ドキュメント作成について

アプリやプロジェクトのドキュメント作りですが、時間が立ったり、複数人での開発を行うと 情報の漏れや抜けが非常に多くなる 本番との差分ができる 一部の人しか更新しなくなる 似たようなドキュメントがあちこ …