SGDoc

ဒီနေ့ ရုံးမှာ အလုပ်အတွက် API request documentation တွေ ပြန်စစ်နေတုန်း MS Word မှာ API request တွေကို ရေးထားတာ ဖတ်ရခက်လိုက်တာ လို့ ထင်လာတယ်။ ဘာထွေထွေထူးထူး မှတော့ မဟုတ်ပါဘူး။ Request နဲ့ Response တွေပဲ ရေးထားတာပဲ။ သို့ပေမယ့် တစ်ခုခု ပြန်ရှာမယ်ဆိုရင် search လုပ်ပြီး ပြန်ပြန်ရှာနေရတော့ ရှာရတာ အဆင်မပြေဘူးထင်လာတယ်။ Documentation တွေကြည့်ရင်းနဲ့ markdown က HTML documentation generate လုပ်ပေးတာ ရှိမလား ဆိုပြီး ရှာကြည့်လိုက်တော့ daux.io နဲ့ FlatDoc ကို တွေ့တယ်။

၂ ခု လုံးကတော့ မဆိုးပါဘူး။ Daux က PHP ကို အသုံးပြုပြီးတော့ generate လုပ်တာဆိုတော့ သူ့ကိုလုပ်တာဆိုတော့ သူ့ကို run ဖို့အတွက်က PHP အလုပ်လုပ်တဲ့ Web Server တစ်ခုခုပေါ်ကနေ run မှ ရတယ်။ email ကနေ document ကို ပေးခြင်ရင် မဖြစ်ပြန်ဘူး။ FlatDoc ကတော့ server side မပါပဲ ajax ကနေ markdown file ကို ဖတ်ပြီးတော့ generate လုပ်တာဆိုတော့ file:// ဆိုပြီး run လို့ မရတော့ဘူး။ ajax အလုပ်လုပ်အောင် server ကနေ run ရပြန်တာပဲ။ FlatDoc က ဖတ်ရတာ ပိုလွယ်ပြီး ကြည့်ရတာ အဆင်ပြေတဲ့အတွက် ပိုသဘောကျ ပေမယ့် အသုံးပြုလို့မရဘူး။ ဒါနဲ့ ကိုယ့်ဘာသာကိုယ် markdown documentation generator တစ်ခု ရေးကြည့်လိုက်တယ်။

SGDoc က node.js နဲ့ ရေးထားတဲ့အတွက် သူ့ကို သွင်းဖို့က node js နဲ့ npm သွင်းထားဖို့လိုပါတယ်။ sgdoc က markdown file ကို html file အဖြစ်ပြောင်းပေးတယ်။ နောက်ပြီးတော့ header level တွေကို သီးသန့် ခွဲထုတ်ပြီးတော့ menu အနေနဲ့ ပြထားပေးတဲ့အတွက် document ဖတ်တဲ့ အခါမှာ ပိုပြီး ရိုးရှင်းလွယ်ကူပါတယ်။ မဖတ်သေးခင်မှာ ဘာ ခေါင်းစဉ်တွေ ပါလဲဆိုတာ လွယ်လင့် တကူ သိနိုင်သလို ကိုယ်သွားချင်တဲ့ ခေါင်းစဉ်ကိုလည်း click လုပ်လိုက်တာနဲ့ ရောက်သွားအောင် ဖန်တီးထားပေးတယ်။ ထွက်လာတာ HTML file တစ်ခုတည်းဖြစ်တဲ့အတွက်ကြောင့် email ကနေ ဖြစ်ဖြစ် dropbox ကနေ ဖြစ်ဖြစ် share ရတာ လွယ်ပါတယ်။

သို့ပေမယ် ပြဿနာလေးတွေက တစ်ယောက်ယောက်က ပြန်ပြင်ချင်ရင် မလွယ်တာပဲ။ မူရင်း markdown file ကို ပြန်မပြင်နိုင်တဲ့အတွက် flatdoc နဲ့ ယှဉ်ရင် contribution ပိုင်း အဆင်မပြေသေးဘူး။ PM က မှားနေတာ တွေ့လို့ ပြင်မယ်ဆို ရင် လွယ်လွယ် နဲ့ ပြင်မရတဲ့အတွက် team ထဲမှာ share မယ်ဆိုရင် HTML ကို copy လုပ် Pages ထဲမှာ page လုပ်ပြီး words file ပြန်ပြောင်းနေရသေးတယ်။ ဒါကြောင့် rtf တစ်ခါတည်း ထုတ်နိုင်ရင် ပိုကောင်းမယ်လို့ တော့ စဉ်းစားမိတယ်။ သို့ပေမယ့် အခုတော့ ထပ်ပြီးတော့ update လုပ်ဖို့ အစီအစဉ် မရှိသေးပါဘူး။

Update: SGDoc ကို အခြေခံပြီးတော့ သမာရိုးကျ HTML နဲ့ javascript ကို သုံးပြီးတော့ EasyDoc ဆိုတာကို ထပ်ပြီး ရေးလိုက်တယ်။ ဘာမှ လုပ်နေစရာမလိုပဲ index.html မှာ markdown ရေးပြီး လွယ်လင့် တကူ မည်သူမဆို ပြင်နိုင်အောင် လုပ်ထားပေးပါတယ်။


Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Up Next:

Six Years Old

Six Years Old