CE Project: The Great CE Documentation Project

Replies

• 

  Kaustubh Katdare

  Re: The Great CE Documentation Project
  
  No response so far? I guess no one wants to do the dirty job? 😁 , well its not dirty.
  
  I'll be working on the project soon, but it will take lot of time to complete if we've only one resource ( 😁 ) working on the project.
  
  -The Big K-
• 

  LORD_EC

  Re: The Great CE Documentation Project
  
  Biggy
  I can write it but do you actually think that people read these guides ?? They learn through experiences.They post in wrong threads then they get warning from admin then they got to know their mistakes.
  Its their way to learn.So I dont think that anyone reads them.
  But still I'll make it (though some time is needed)
• 

  Kaustubh Katdare

  Re: The Great CE Documentation Project
  
  I completely agree with you. No one would actively go and read the guidelines. However, it helps to have the steps documented so that we don't have to repeat ourselves. Moreover, we can always promote links to our Guide through our signature so that people know where to look for when they need help.
  
  I regularly answer queries like "How do I register on CE?", "How to post?" , "Can you help with with seminar topic?" etc.
  
  We'd create a simple guide which will contain topics like -
  
  "How to register" , "How to post" , "How to ask help" , "Posting guidelines", "how to update profiles/signatures" , "how to start a poll" etc.
  
  This is just a one-time activity, but its a must, I believe.
  
  We won't be compiling kilos of lines for this simple guide, just a basic how to for CE Forums.
  
  -The Big K-
• 

  LORD_EC

  Re: The Great CE Documentation Project
  
  hmmn...Right to some extent.
  Ok,I will make it.But it'll take some time if you dont mind.If you need them early then you need to tell me the exact date.
  
  Regards
  lord.ec
• 

  Elisa

  Re: The Great CE Documentation Project
  
  

  The_Big_K

  So, say 'aye' if you are in!
  
  -The Big K-

  aye!
  
  May I work on control panel related documentation? We will need a template to follow. Biggie, please post a template or a sample article for us.
• 

  Prasad Ajinkya

  Re: The Great CE Documentation Project
  
  How about a simple format -
  
  Index will be a "How do I" list of things -
  eg-
  
  Q. How do I become a CEan?
  A. You register of course! Heres the , input all your user details and click the register button. You will get a mail to confirm the.. blah blah blah.
  Voila!! You are officially now a CEan!! Please see the introductions forum and introduce yourself as a crazy engineer!
• 

  Kaustubh Katdare

  Re: The Great CE Documentation Project
  
  

  kidakaka

  How about a simple format -
  
  Index will be a "How do I" list of things -
  eg-
  
  Q. How do I become a CEan?
  A. You register of course! Heres the , input all your user details and click the register button. You will get a mail to confirm the.. blah blah blah.
  Voila!! You are officially now a CEan!! Please see the introductions forum and introduce yourself as a crazy engineer!

  This is cool. As Elisa suggested, I'll post a sample article soon.
• 

  Ashraf HZ

  Re: The Great CE Documentation Project
  
  I'll try to contribute too 😀
  
  EDIT: I remember we planned to do the screencast of how to do things here on CE. Anyone made progress with that?
• 

  gohm

  Re: The Great CE Documentation Project
  
  Isn't there already a FAQ section? I see the button. Do we just need to add info to the faq? You can tell I haven't actively read a lot of the guidelines either... =)
  thanks,
• 

  Kaustubh Katdare

  Re: The Great CE Documentation Project
  
  

  gohm

  Isn't there already a FAQ section? I see the button. Do we just need to add info to the faq? You can tell I haven't actively read a lot of the guidelines either... =)
  thanks,

  Yep, we do have FAQ section. However, it does not solve the purpose. How about coming up with a tiny, good looking guide that contains information under various titles?
  
  We can make it available as a pdf or a power point presentation (so that its easier to use). However, the documentation project is not on our priority list right now.
• 

  Ashraf HZ

  Re: The Great CE Documentation Project
  
  Hm, I don't think many would bother to "download" it. Too many steps to take 😉 Perhaps its best to keep it as easy accessible (and attractive) as possible. For example, to keep the guide concise, we could collapse the "answers" under a Question, which would expand only after you click it.
  
  Btw, Im going to try to give the screencast a shot this weekend. Probably something about How to Post etc.