hayat01sh1daのブックマーク (2)

  • 社内技術ドキュメンテーションを科学する - スタディサプリ Product Team Blog

    最終更新日: 2024年02月27日(月) 1. ご挨拶 2. 記事執筆のモチベーション 3. ワークショップを通じて得たフィードバック 3-1. Pains -過去抱えた/現在進行形で抱えている辛み- 3-2. Approaches/Solutions -Pains を解消するために取った方策や導き出した解決策- 3-2-1. えいやで場所を決め打ちしてしまう(e.g., GitHub Wiki + Google docs しか使わない) 3-2-2. 個人的に、2023/12/05時点で〜みたいな書き方を心がけている 3-3. Tips -効果的な手法- 4. オーディエンスからの反響 4-1. 気づきや学び・NEXT ACTIONS 4-2. プレゼンター(@hayat01sh1da)へのフィードバック 4-3. Slack での反応 5. おわりに 1. ご挨拶 初投稿となります

    社内技術ドキュメンテーションを科学する - スタディサプリ Product Team Blog
    hayat01sh1da
    hayat01sh1da 2023/12/18
    @BOOOOOOOON 書いた本人です。メンテし続けるのに限界が来たらアーカイヴして、その価値を再考するも手だと思います。あとは仕組み化出来るものは文書からオプトアウトさせていくと開発にリソースを割けそうですね。
  • ドキュメント管理を制する 陳腐化を防ぐための実践事例 Lunch LT に登壇しました | フューチャー技術ブログ

    2023/12/6、Findyさん主催のドキュメント管理を制する 陳腐化を防ぐための実践事例 Lunch LT に「設計ドキュメント腐る問題、Git管理で運用してみた当のところ」というタイトルで登壇しました。 togetter スライドまとめ ドキュメント管理を制する 陳腐化を防ぐための実践事例 Lunch LT 会とはドキュメントの管理方法を確立、整備されてこられた方々にお話を伺い、工夫点や考え方、テクニック等を広く共有していただくことで、明日から使える技術やノウハウを共有することを目的にした勉強会です。 Lunch LTということで、お昼時に4名で10分枠、質疑応答で15分ごとに交代でした。私の家族構成的に夕方以降の勉強会参加が厳しいので、ランチLTだと視聴だけではなく登壇もできるということで、控えめに言って画期的だなと思いました。 登壇トップバッターで「設計ドキュメント腐る問題、G

    ドキュメント管理を制する 陳腐化を防ぐための実践事例 Lunch LT に登壇しました | フューチャー技術ブログ
    hayat01sh1da
    hayat01sh1da 2023/12/16
    最近私が書いた記事とテーマが近似していたので拝読致しました。「社内ドキュメント運営はブログ運営に似ている」は個人的にとても共感する金言だと思いました!https://blog.studysapuri.jp/entry/science-of-inhouse-tech-documentation
  • 1