Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

This article is a Private article. Only a writer and users who know the URL can access it.
Please change open range to public in publish setting if you want to share this article with other users.

More than 5 years have passed since last update.

Markdownで行こう!2014

Last updated at Posted at 2014-11-30

この記事は社内用 Advent Calendar 2014用の記事として投稿しています。
会社の人にしか分からない内容を含むため、限定共有で作成しています。

#はじめに
ついにAdvent Calendar 2014が始まりました!初日担当の平木です。
昨年に続き、二年連続で投稿させて頂きます。

昨年は「Markdownで行こう!」と題して、「仕事でMarkdownを使えないか模索してます!」という記事を書きました。
要約すると

  • Excel方眼紙つらい
  • Markdown便利
  • 運用定義書とかMarkdownで書けばいいんじゃない?
  • お客様にもMarkdown覚えてもらえば万事OK

こんな感じです。

で、この一年どうだったかというと…結局お客様にはMarkdownを使ってもらえず、私もいまだにExcel方眼紙で資料を作成する日々を送っています。

ただ、まだMarkdownの可能性をあきらめたわけではありません。
というわけで、現在の取り組みを書いてみようと思います。

#ところでMarkdownって何よ?
前置きが長くなりました。
まずは「そもそもMarkdownって何?」って方のために、簡単に概要を。

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。もともとは読みやすいプレーンテキスト形式の文書をHTML化するために開発されたものの、現在ではHTMLのほかパワーポイント形式やLATEX形式のファイルへ変換するソフトウェア(コンバータ)も開発されている。コンバータの開発者により追加される機能(方言)が多様であり、拡張性に富む記法であることが伺える。
Wikipediaより引用

ざっくりいうと、メモ帳で「Markdown記法」と呼ばれる記法で文章を書くと、すごく見やすい形でHTMLに変換できます。というものです。

たとえば


1. りんご
1. みかん
1. バナナ

と書くと、↓のようなHTMLに変換されて

<ol>
<li>りんご</li>
<li>みかん</li>
<li>バナナ</li>
</ol>

最終的に


1. りんご
2. みかん
3. バナナ

と表示されます。

ほかにも色々な記法があります。
記法自体はすごく簡単なので、割とすぐに覚えられます。一度覚えると普段のメモ書きや議事録取りにも使いたくなるような勝手の良さです。

#ところで今見てるこのQiitaってサイトは何?
突然みなさんをお招きしたこの場所「Qiita」
プログラマーなら割とお目にかかる機会も多いかと思いますが、プログラマー同士の情報共有サイトです。
日本、あるいは世界のプログラマーが、自分達の得た知識を日々投稿して情報共有しています。
社内でも活用している人は結構いるみたい(?)

このQiitaで記事を書く際にもMarkdownが使われています。
実際、この記事も編集している最中はこんな感じ

qiitadraft.png

このQiita、良いところは多々あるのですが、そのなかでもソースコードが「シンタックスハイライト」されるあたりが一押しです。

たとえば


\`\`\`sql
SELECT *
FROM M_Shouhin
WHERE ShouhinCD = '100' 
```

こんな風に書くと

SELECT *
FROM M_Shouhin
WHERE ShouhinCD = '100' 

と表示されます。

アカウント登録していなくても記事は見ることはできますが、プログラマーならぜひアカウント登録することをオススメします。
(アカウント登録すると、記事を「ストック」したり、タグや他のアカウントをフォローすることで最新情報をすぐに取得できたりします。)


さて、皆さんはこのQiitaを見たときに何を感じたでしょうか?

私はまず
「社内にQiitaがあればなぁ…」
でした。

社内の部品の使い方や製品の設定方法など、書き留めたいことは多々あります。
最近はExcelに内容をまとめて、Chatterで共有している方もいらっしゃいますよね。

ただ、Excelはちょっとアレ(詳しくは省略します)ですし、Chatterはコード書くのに適していないし…
社内にQiitaがあれば、情報共有や情報発信がすごくやりやすくなるのに…

そういうニーズに対応するために、QiitaにはQiita:Teamという、企業で使用することを前提としたサービスが用意されています。
ただし、Qiita:Teamは有料サービスです。

17名までは月額15,000円。それ以上は1名につき月額700円。
仮にプログラマーが300名だとしたら、月額213,100円。年間で2,557,200円。

これを安いと見るか高いと見るかは置いておいて…
こういったサービスを導入するにあたって、「費用対効果」がいかほどのものかが一つの尺度になると思いますが、なかなか試算は難しい。
さらにプログラマーだけのために導入するのもどうか、という点も気になります。(ちなみに私はPEじゃなくてSEですよ。)

当社でQiita:Teamを導入する場合、道のりは長そうな気がします。

上流工程で要件定義とか運用定義とかしているSEがこんなこと言っちゃダメかもしれませんが、正味の話
使ってみないと効果とかわかんねーよ
と思うわけですw

使ってみないと分からない…
導入するには壁が高そう…


       |
   \  __  /
   _ (m) _ピコーン
      |ミ|
    /  `´  \
     ('A`)
     ノヽノヽ
       くく

というわけで

#作ってみました、社内用Qiita
作ってみましたw
実は昨年のAdvent Calendarや、Yammerを使ってる頃から一部では「社内Qiita構想」あったのですが、なかなか着手には至らず。
Advent Calendar 2014の話題が出たのをいい機会に着手してみました。

ちなみに世の中では、クラウドサービスなどをクローズドな環境で使えるように作られたコピー製品を「クローン」と呼びます。
GitHubクローンのGitLabやGitBucketなどが有名。

それでは社内用のQiitaクローン Hinata のお披露目といきましょう。

##URL
https://hinata-ob.azurewebsites.net/

上記URLに当社用の環境を構築しました。
「社内用」と付けましたが、実際はAzureで動作することを前提にしています。

##アカウント登録
最初にE-Mailアドレスを登録して頂きます。
登録できるアドレスは当社のドメインに限定しています。

accountregister01.png

登録すると、登録確認メールが届きます。
メールに書いてあるURLをクリックすることで登録完了です。

accountregister02.png

これで、理論上は会社のメールアドレスを持っている人しかアカウント登録できないようにしています。

##できること

  • 記事の下書き
  • 記事の投稿
  • 限定共有
  • シンタックスハイライト
  • 画像登録
  • タグ登録

#いかがでしょう?
いかがでしょうと聞かれてもねw
デザインはそっけないわ、使い方の説明はどこにも書いてないわ…

そうです。未完成なんです。

つーか、一人で、仕事外で、寝る時間削って、一ヶ月程度で完璧なものなんて作れるか!

と、独り言ちるのは冗談として
とりあえず最小限の機能だけでリリースしました。

これから機能を随時追加していくつもりです。

しかしながら、「一人で作れるか!」っていうところは本音。
なので、これから書くことがこの記事の本題です。

#オープンソースとして公開
このHinataですが、GitHubにMITライセンスで公開しました。
GitHubとかMITライセンスの話を書くと、AdventCalendarを5日ぐらい消化できるのでここでは書きませんが…

オープンソースです。
ソースコード、誰でも見られます。
欲しい機能があれば、コード書いてPullRequest送ってくれれば反映します。


今の時代、オープンソースソフトウェア(OSS)を使うのは当たり前になっています。
当社でもWebシステムにかかわった人ならご存知だと思いますが、「jQuery」なんかOSSですよね。

さらにMicrosoftが今、OSSに大きく舵を切っています。
ASP.NET 5(ASP.NET vNext)などもOSSとしてGitHubにソースコードが公開されています。
最近リリーされた無料のVisual Studio 2013 Communityは「OSSに貢献する開発者向け」って書いてあったりします。

これからプログラマーは…いや、プログラマーに限らずITに関わる人は全員、OSSに対する知識を身に着けないと、やっていけなくなりそうです。

というわけで、OSSに貢献する練習台で構わないので、Hinataプロジェクトに参加してくれる人を募集しています。

GitHubのリポジトリは↓です。
Wabyon/Hinata

社内の部品とか使ってないのでご安心ください。

#さいごに
最後の方はだいぶ投げっぱなし感がありますが、長くなっちゃうのでAdvent Calendarの記事としてはここまでにします。
本当はGitHubの使い方とか、Gitの使い方とか、Azureの設定とか色々書きたい><
けど、それは追々…誰か書いてくれないかなぁ… [壁]_・)チラッ

GitHubのリポジトリも、本当は開発フローとか明記しないといけないところですが…
お正月休みあたりにキレイにしようと思います…
興味を持たれた方は、ぜひ直接お問い合わせくださいw


最近は「できるだけ開発しない」という流れの中、技術者のアイデンティティが何かを本気で考える時期に差し掛かっていると思います。
(これは別に当社に限った状況ではなさそうです。)

「開発しない」とはいえITを前提にビジネスをする以上、技術力も蔑ろにはできません。
そこに昨今のOSSの流れ。

個人的には、当社からOSSに貢献して世界に知られるエンジニアを出したいなぁなんて夢想しています。

Microsoftの戦略を見るに、2015年は技術的に激動の一年になりそうな予感。
普段の仕事も忙しいですが、頑張って技術力も磨いていきましょう!
(その前に3Q売りを何とかしないと…)


それでは、Advent Calendar 2日目以降の皆様の記事を楽しみにしていますノシ

##さいごのさいごに
https://hinata-ob.azurewebsites.net/

こちらのサイトですが、あくまで私個人のAzure契約内で構築した環境です。
使っていただけると嬉しいのですが、サブスクリプションの料金を超えると止まります。
投稿された記事も消えて無くなる可能性があるので、その点はご了承ください。

あと、社内の機密情報はUPしないで下さいね。

もし効果がありそうなら、会社に使ってもらえないか交渉してみたいですね。
なので皆さんにぜひ使ってもらって、フィードバックが欲しいのです。
フィードバックはGitHubのIssuesへお願いします。

0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?