[B! documentation] akkun_choiã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

akkun_choi id:akkun_choi

documentationã«é–¢ã™ã‚‹akkun_choiã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (7)

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

${{author_name}}$
{{author_name}}{{created}}
{{ #comment }}{{ comment }}{{ /comment }}
- {{ label }}

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

ç¤¼å„€æ£ã—ã•é‡è¦ï¼ˆGood Manners Matter æ—¥æœ¬èªžè¨³ï¼‰
ä»¥ä¸‹ã®æ–‡ç« ã¯ã€Rich Bowen ã«ã‚ˆã‚‹ Good Manners Matterï¼ˆOpen Advice ã«åŽéŒ²ï¼‰ã®æ—¥æœ¬èªžè¨³ã§ã‚ã‚‹ã€‚ Rich Bowen ã¯ã€ç´„15å¹´ã‚‚ã®é–“ãƒ•ãƒªãƒ¼ï¼ã‚ªãƒ¼ãƒ—ãƒ³ã‚½ãƒ¼ã‚¹ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã«æºã‚ã£ã¦ããŸã€‚ãã®æ™‚é–“ã®å¤§åŠã¯ Apache HTTP Server ã«è²»ã‚„ã—ã¦ããŸãŒã€Perl ã‚„ PHP ã‚„ã„ã‚ã‚“ãªã‚¦ã‚§ãƒ–ã‚¢ãƒ—ãƒªã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã«ã‚‚å–ã‚Šçµ„ã‚“ã§ããŸã€‚å½¼ã¯ã€ŽApache Cookbookã€ã‚„ã€ŽThe Definitive Guide to Apache mod_rewriteã€ä»–ã„ã‚ã‚“ãªæœ¬ã®è‘—è€…ã§ã‚ã‚Šã€æ§˜ã€…ãªæŠ€è¡“ã‚«ãƒ³ãƒ•ã‚¡ãƒ¬ãƒ³ã‚¹ã«é »ç¹ã«å‚åŠ ã—ã¦ã„ã‚‹ã€‚ åƒ•ã¯2000å¹´ã®9æœˆã« Apache HTTP Server ã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã«æºã‚ã‚Šå‡ºã—ãŸã€‚å°‘ãªãã¨ã‚‚ã€åƒ•ãŒåˆã‚ã¦ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ã‚³ãƒŸãƒƒãƒˆã—ãŸã®ã¯ãã®ã¨ãã ã£ãŸã€‚ãã‚Œä»¥å‰ã¯é›»åãƒ¡ãƒ¼ãƒ«ã§ã„ãã¤ã‹ãƒ‘ãƒƒãƒã‚’ç™»éŒ²ã—
akkun_choi 2012/06/25
ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã®å°‚é–€å®¶ã€‚æ€ æƒ°ã€å¿è€ã€è¬™è™šã€‚æŠ€è¡“ãŒé“å…·ã«ã™ãŽãªã„äººãŸã¡ã«æ•¬æ„ã‚’

writing

documentation
ãƒªãƒ³ã‚¯
Pandoc - index
If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (â† = conversion from; â†’ = conversion to; â†”ï¸Ž = conversion from and to) Lightweight markup formats â†”ï¸Ž Markdown (including CommonMark and GitHub-flavored Markdown) â†”ï¸Ž reStructuredText â†’ AsciiDoc â†”ï¸Ž Emacs Org-Mode â†”ï¸Ž Emacs Muse â†”ï¸Ž Textile â†’ Markua â† txt2t
akkun_choi 2011/12/04
å„ç¨®è¨˜æ³•ã®ç›¸äº’å¤‰æ›

markdown

html

documentation
ãƒªãƒ³ã‚¯
GitHubã«è¼‰ã›ã‚‹HTMLãƒ•ã‚¡ã‚¤ãƒ«ã‚’ã‚³ãƒ¼ãƒ‰ã‹ã‚‰ç”ŸæˆÂ·Paige MOONGIFT
Paigeã¯ã‚³ãƒ¼ãƒ‰ã‚„READMEã‹ã‚‰GitHubå‘ã‘ã®é™çš„ãªHTMLãƒ•ã‚¡ã‚¤ãƒ«ã‚’ç”Ÿæˆã™ã‚‹ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã§ã™ã€‚ ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã¯ç°¡å˜ã§ã€Œnpm install paigeã€ã®ã¿ã§ã™ã€‚å®Ÿè¡Œã¯ã€Œpaige path/to/configã€ã«ãªã‚Šã¾ã™ã€‚ å®Ÿéš›ã«Paigeã‚’ä½¿ã£ã¦ä½œã‚‰ã‚ŒãŸã‚¤ãƒ³ãƒ‡ãƒƒã‚¯ã‚¹ãƒšãƒ¼ã‚¸ã§ã™ã€‚ å…ƒã«ãªã£ã¦ã„ã‚‹ã®ã¯READMEãƒ•ã‚¡ã‚¤ãƒ«ã§ã™ã€‚Markdownè¨˜è¿°ã®ãƒ•ã‚¡ã‚¤ãƒ«ï¼ˆæã‚‰ããã‚Œä»¥å¤–ã‚‚å¯ï¼‰ã‹ã‚‰HTMLã‚’ç”Ÿæˆã—ã¦ã„ã¾ã™ã€‚ ã‚½ãƒ¼ã‚¹ãƒ•ã‚¡ã‚¤ãƒ«ã”ã¨ã«èª¬æ˜Žãƒšãƒ¼ã‚¸ãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚å·¦ã«èª¬æ˜Žã€å³ã«ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚çµæ§‹è¦‹ã‚„ã™ã„ã§ã™ã€‚ å…ƒã«ãªã£ãŸã‚³ãƒ¼ãƒ‰ã§ã™ã€‚ã‚³ãƒ¡ãƒ³ãƒˆãŒãã®ã¾ã¾ãƒ†ã‚ã‚¹ãƒˆã¨ã—ã¦èª¬æ˜Žæ–‡ã«ä½¿ã‚ã‚Œã¦ã„ã‚‹å½¢ã«ãªã‚Šã¾ã™ã€‚ ã“ã®ã‚ˆã†ãªè¨å®šã‚’è¨˜è¿°ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ ã“ã®æ‰‹ã®ã‚¸ã‚§ãƒãƒ¬ãƒ¼ã‚¿ã¯è‰²ã€…ã‚ã‚Šã¾ã™ãŒã€Paigeã¯ã‹ãªã‚Šã‚·ãƒ³ãƒ—ãƒ«ã«ä½¿ãˆã‚‹å°è±¡ã§ã™ã€‚GitHubå‘ã‘ã¨éŠ˜æ‰“ãŸã‚Œã¦ã„ã‚‹é€šã‚Šã€GitHubå‘ã‘
akkun_choi 2011/12/01
github

node.js

documentation
ãƒªãƒ³ã‚¯
è«–ç†çš„ãªãƒ—ãƒã‚°ãƒ©ãƒ ã‚’æ›¸ããƒ—ãƒã‚°ãƒ©ãƒžã¯ã€è«–ç†çš„ãªæ–‡ç« ã‚‚æ›¸ã‘ã‚‹ã‹ï¼Ÿ
è«–ç†çš„ãªãƒ—ãƒã‚°ãƒ©ãƒ ã‚’æ›¸ããƒ—ãƒã‚°ãƒ©ãƒžã¯ã€è«–ç†çš„ãªæ–‡ç« ã‚‚æ›¸ã‘ã‚‹ã‹ï¼Ÿï¼šèª°ã«ã§ã‚‚åˆ†ã‹ã‚‹SEã®ãŸã‚ã®æ–‡ç« è¡“ï¼ˆ10ï¼‰ï¼ˆ1/2 ãƒšãƒ¼ã‚¸ï¼‰ ã€Œææ¡ˆæ›¸ã€ã‚„ã€Œè¦ä»¶å®šç¾©æ›¸ã€ã¯æ›¸ãã®ãŒé›£ã—ã„ã€‚èªã‚€äººãŒITã®å°‚é–€å®¶ã§ã¯ãªã„ã‹ã‚‰ã ã€‚å°‚é–€ç”¨èªžã‚’ä½¿ã‚ãšã€é«˜åº¦ãªå†…å®¹ã‚’çš„ç¢ºã«ä¼ãˆã‚‹ã«ã¯ã©ã†ã™ã‚Œã°ã„ã„ã‹ã€‚ã€Œææ¡ˆæ›¸ã€ã€Œè¦ä»¶å®šç¾©æ›¸ã€ã®æ›¸ãæ–¹ã‚’é€šã˜ã¦ã€ã€Œèª°ã«ã§ã‚‚ä¼ã‚ã‚‹ã€æ–‡ç« è¡“ã‚’ä¼æŽˆã™ã‚‹ã€‚ é€£è¼‰ã®ç¬¬5å›žã€Œãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã®è³ªã‚’ç¢ºå®Ÿã«ä¸Šã’ã‚‹6ã¤ã®æ–‡ç« ä½œæ³•ã€ã€ç¬¬6å›žã€Œèªã¿ã‚„ã™ã„æ–‡ç« ã®æ¥µæ„ã¯ã€Žä¿®é£¾èªžã€ã«ã‚ã‚Šã€ã§ã¯ã€åˆ†ã‹ã‚Šã‚„ã™ã„æ–‡ç« ã‚’è¨˜è¿°ã™ã‚‹ãŸã‚ã®ãƒã‚¤ãƒ³ãƒˆã‚’èª¬æ˜Žã—ã¾ã—ãŸã€‚ èªã¿æ‰‹ã«ç†è§£ã—ã¦ã‚‚ã‚‰ãˆã‚‹æ–‡ç« è¡¨ç¾ã«ã™ã‚‹ãŸã‚ã«ã¯ã€1ã¤ã²ã¨ã¤ã®æ–‡ç« ã‚’åˆ†ã‹ã‚Šã‚„ã™ãè¨˜è¿°ã™ã‚‹ã ã‘ã§ãªãã€æ–‡ç« ã®æµã‚Œï¼ˆæ–‡ç« ã®ã¤ãªãŒã‚Šï¼‰ãŒèªã¿æ‰‹ã«ã¨ã£ã¦åˆ†ã‹ã‚Šã‚„ã™ã„ã‚‚ã®ã§ãªã‘ã‚Œã°ãªã‚Šã¾ã›ã‚“ã€‚ãã“ã§ä»Šå›žã¯ã€ã€Œåˆ†ã‹ã‚Šã‚„ã™ã„æ–‡ç« ã®æµã‚Œã€ã‚’æ§‹æˆã™ã‚‹ãƒã‚¤ãƒ³ãƒˆã‚’è§£èª¬ã—ã¾ã™ã€‚ è«–ç†æ€è€ƒã«æ…£ã‚Œã¦ã„ã‚‹æŠ€è¡“
akkun_choi 2011/07/10
documentation

writing
ãƒªãƒ³ã‚¯
ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã‚’åŠ é€Ÿã™ã‚‹ã‚¹ãƒˆãƒ¬ã‚¹ãƒ•ãƒªãƒ¼ã®ä½œå›³ãƒ„ãƒ¼ãƒ«ã€Žblockdiagã€ jus2011å¹´6æœˆå‹‰å¼·ä¼š
ã‚·ã‚¹ãƒ†ãƒ é–‹ç™ºã‚„ä¿å®ˆã€é‹ç”¨ã®ç¾å ´ã«ãŠã„ã¦ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã¯å¿…é ˆã®ã‚‚ã®ã§ã™ã€‚ ã—ã‹ã—ã€ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã®ä½œæˆãƒ»ç¶æŒã«ã¯å¤šãã®ãƒ‘ãƒ¯ãƒ¼ãŒã‹ã‹ã‚‹ãŸã‚ã€ãƒ‰ã‚ãƒ¥ ãƒ¡ãƒ³ãƒˆãŒå˜åœ¨ã—ãªã„ã€è³‡æ–™ãŒå¤ã„ã¾ã¾ã«ãªã£ã¦ã„ã‚‹ãªã©ã¨ã„ã£ãŸç¾çŠ¶ã‚’å¤šã è€³ã«ã—ã¾ã™ã€‚ æœ¬å‹‰å¼·ä¼šã§ã¯ã“ã‚Œã‚‰ã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã§ã‚ˆãåˆ©ç”¨ã•ã‚Œã‚‹ã€Œå›³ã€ã«ãƒ•ã‚©ãƒ¼ã‚«ã‚¹ã—ã€ ã¿ã‚‹ã¿ã‚‹ã†ã¡ã«å›³ã‚’ä½œæˆã§ãã‚‹ã€Œblockdiagã€ã‚’ã”ç´¹ä»‹ã—ã¾ã™ã€‚ ã€Œblockdiagã€ã¯ã‚·ãƒ³ãƒ—ãƒ«ãªãƒ†ã‚ã‚¹ãƒˆè¨˜è¿°ã‹ã‚‰ãƒ–ãƒãƒƒã‚¯å›³ã€ãƒãƒƒãƒˆãƒ¯ãƒ¼ã‚¯å›³ãªã©ã® ç”»åƒãƒ•ã‚¡ã‚¤ãƒ«ã‚’å‡ºåŠ›å¯èƒ½ãªã‚ªãƒ¼ãƒ—ãƒ³ã‚½ãƒ¼ã‚¹ã®ç”»åƒç”Ÿæˆãƒ„ãƒ¼ãƒ«ã§ã™ã€‚æ›¸ã ã‚„ã™ã•ã€ãƒ¡ãƒ³ãƒ†ãƒŠãƒ³ã‚¹ã—ã‚„ã™ã•ã‚’ä¸å¿ƒã«ãƒ‡ã‚¶ã‚¤ãƒ³ã•ã‚Œã¦ãŠã‚Šã€å›³ã‚’ä½œã‚‹ã®ã« é…ç½®ã‚„ä¸¦ã¹æ›¿ãˆã«è‹¦åŠ´ã™ã‚‹å¿…è¦ã¯ã‚ã‚Šã¾ã›ã‚“ã€‚ blockdiagã®ã‚µãƒ³ãƒ—ãƒ«ã¯ã“ã¡ã‚‰ ã“ã®ã‚ˆã†ãªç‰¹å¾´ã‚’æŒã¤ã€Œblockdiagã€ã¨ã€ã‚·ãƒ³ãƒ—ãƒ«ãªè¨˜è¿°ã§ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ä½œæˆ ã™ã‚‹ãƒ„ãƒ¼ãƒ«ã€ŒSphinxã€ã‚’çµ„ã¿åˆã‚ã›ã‚‹ã“ã¨ã«ã‚ˆã£ã¦
akkun_choi 2011/06/19
documentation
ãƒªãƒ³ã‚¯
The Most Important Code Isn't Code
Documentation is the single most important change Iâ€™ve made to my coding style in the last year. Documentation is Personal Iâ€™m not talking about injecting a few comments in front of confusing lines here and there. Iâ€™m talking about taking a firm, consistent view at how you document your methods, your classes, and your projects, and then sticking to that mentality. Documentation is mostly described
akkun_choi 2011/06/08
documentation

dev
ãƒªãƒ³ã‚¯
1