タグ

documentに関するmakoreeのブックマーク (6)

  • MySQL AB :: MySQL 4.1 リファレンスマニュアル

    概要 これは MySQL リファレンスマニュアルです。 MySQL 8.0 から 8.0.25、および NDB のバージョン 8.0 から 8.0.25-ndb-8.0.25 に基づく NDB Cluster リリースについてそれぞれ説明します。 まだリリースされていない MySQL バージョンの機能のドキュメントが含まれている場合があります。 リリースされたバージョンの詳細は、「MySQL 8.0 リリースノート」を参照してください。 MySQL 8.0 の機能. このマニュアルでは、MySQL 8.0 のエディションによっては含まれていない機能について説明します。このような機能は、ご自身にライセンス付与されている MySQL 8.0 のエディションに含まれていない場合があります。 MySQL 8.0 の使用しているエディションに含まれる機能に関する質問がある場合は、MySQL 8.0

    makoree
    makoree 2024/05/16
    “MySQL 8.0 リファレンスマニュアル”
  • わかりやすいシステム構成図の書き方 - Qiita

    わかりにくいシステム構成図とは こんなシステム構成図を書いてないでしょうか? このシステム構成図のわかりにくい点が3つあります。それは 製品名は書いてあるが「役割」が書いていない データと処理が区別できない データの流れと制御の流れが区別できない の3つです。 わかりやすいシステム構成図 これら3つのわかりにくい点を改善したわかりやすいシステム構成図が↓です ポイントを解説していきます ポイント1. 製品名称ではなく「役割」を書く システム構成図には製品名称ではなくシステムコンポーネントの「役割」を書きます。 役割とは、例えば〇〇データや〇〇処理といったことであり、それを読むだけでシステムの動きを理解できる文字列です。役割をかかずに製品名称のみを書いてしまうと、その製品を知らない人が見たときに理解できません。例えば「Cloud Pub/Sub」という製品はGCPというパブリッククラウドの分

    わかりやすいシステム構成図の書き方 - Qiita
  • テクニカルライティングの基本

    テクニカルライティングの基を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter:https://twitter.com/naoh_nak 2023年度のアップデート版もあります:https://speakerdeck.com/naohiro_nakata/technicalwriting2023

    テクニカルライティングの基本
  • 設計書・仕様書のレビュー方法を定めたJIS規格登場 チェック体制を標準化しやすく

    経済産業省は11月22日、システム開発時に使う設計書・仕様書などの「作業生産物」のレビュー工程についてJIS規格を制定したと発表した。仕様書などの見直し方や観点などを規格化し、ソフトウェアの品質向上や開発の効率化を促す。 「JIS X 20246」は、設計書・仕様書の見直し作業を「計画作業」「レビューの立ち上げ」「個々人のレビュー」「要検討項目の共有および分析」「修正作業および報告作業」の順に整理し、実行するべきタスクや手順を規定するもの。システム開発や試験、保守などの場面で作るあらゆる仕様書に適用可能。 レビューの曖昧さをなくすため、「目的」「役割」などのレビューの観点10種、「執筆者確認」「同僚との机上確認」などのレビュー手法9種を定めた。JIS制定により、組織や個人のノウハウに依存することなく一定水準のレビューができるようになり、ソフトウェアなどの制作物の品質向上につながるとしている

    設計書・仕様書のレビュー方法を定めたJIS規格登場 チェック体制を標準化しやすく
  • LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた

    LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。 そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。 この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介していま

    LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
  • 開発以外でも使える!GitHubの一歩先ゆく活用術【文書校正・仕様書作成】 | SELECK

    スタートアップにおけるソフトウェア開発では今や当たり前となったGitHub。ですが、開発以外の用途にも活用できる可能性があることをご存知でしょうか? SELECKを運営するリレーションズ株式会社では、ソースコードの管理だけではなく、次のような用途にもGitHubを活用しています。 SELECKの記事の品質を上げるための自動校正ツール 誰でも編集でき、どこでも閲覧できる仕様書作成ツール 今回はこの2つの事例を紹介します。 ▼Githubの使い方についてはGithub入門の連載記事をご覧ください。 チーム開発を変える「GitHub」とは?導入方法・使い方を徹底解説!【第1回】【導入編】 GitHubはソースコード管理の枠を越えて活用されている SELECKでは今まで、数々の企業にGitHubの活用方法を取材しました。 GitHub来の使い方であるソースコード管理に主軸を置いたサイバーエージェ

    開発以外でも使える!GitHubの一歩先ゆく活用術【文書校正・仕様書作成】 | SELECK
  • 1