Icy Phoenix

     
 


Post new topic  Reply to topic 
Page 1 of 2
Goto page 1, 2  Next
 
Reply with quote Download Post 
Post Improving Docs Section 
 
Hi guys,
we (the Staff) are trying to improve Documentation section.

At the moment I have just started in renaming some topics by adding a proper TAG prefix.

I would like to have all topics classified just to help users in quickly finding what they need.

At the moment the Docs Section looks like this:

Documentation

What are we doing:
  • Moving outdated docs into Old Docs
  • Adding proper TAGS and topic title
  • Check what is missed and / or incomplete


If you have suggestions, please do... but remember... I won't use Knowledge Base (forum is more flexible, and better indexed...).
 




____________
Luca
SEARCH is the quickest way to get support.
Icy Phoenix ColorizeIt - CustomIcy - HON
 
Mighty GorgonSend private messageSend e-mail to userVisit poster's website  
Back to topPage bottom
Icy Phoenix is an open source project, you can show your appreciation and support future development by donating to the project.

Support us
 
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I should have "rebranded" all topics in there... have a look!

Icy Phoenix Documentation
 




____________
Luca
SEARCH is the quickest way to get support.
Icy Phoenix ColorizeIt - CustomIcy - HON
 
Mighty GorgonSend private messageSend e-mail to userVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Someone has been Very Busy!  

If the "New" section takes one to the old posts and solutions etc, What I would do - And here it comes is:

1. Make the title relevant to the question.
2. Make the first post relevant to the title and add some keywords for better searching.
3. Post the solution to the question in the first post.
4. Create a "Hidden" thread such as "Trash" but more appropriately named.
5. Move all of the other posts from the thread that only take up space to the "New Hidden Thread".
6. Expect that from those who contributed to the solution need to appreciate that all docs are being re-vamped for their benefit also.

Even the ones they didn't contribute to.
 
 
 
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I like the new page just my opinion but yes anything not related to the doc posted could be moved to the hidden forum as Lopalong suggested...

Great idea.. makes searching for an answer a lot easy .. even for me...

   
 




____________
Mods and themes for Icy Phoenix 1.3

IcyPhoenix UK is off-line permanently due to lack of time to update mods.
if anyone is interested in my templates I will upgrade them to Icy 2.0.
 
DWhoSend private messageVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
The problem there is any posts made after a DOC could be important or could include information on how to further that DOC or build onto it.  A lot of work would go into moving everything into one post and in fact may prove unnecessary.

People can get lost in long, drawn-out posts and may not see the solution to their issue in a novelized post.  Perhaps including links to the actual post in the topic that had various solutions could be included in the first post?

I suppose there are pro's and con's in both sides, but splitting a topic to move all posts besides the first should be last resort.
 




____________
| Icy Phoenix ColorizeIt! |
Bipolar Disorder - Not good for you and definitely not good for everyone else.
 
ChaoticSend private messageVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I like the new page  applauso
 




____________
TheSteffen
Often SEARCH is the quickest way to get support.
IcyPhoenix German Support
 
TheSteffenSend private message  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Chaotic wrote: [View Post]
I suppose there are pro's and con's in both sides, but splitting a topic to move all posts besides the first should be last resort.


Doc moved to: CUSTOMIZATION.

All it needs is someone willing to sift through the information in the current "Docs" and do (over time) the same thing to the other ones.  

But I see little sense in having two threads covering the same topic.

        
 
 
Edited by Guest, Tue 08 Sep, 2009 01:00: Moved the script.
 
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
If you want to create a new topic for that, please go ahead.  We'll move it to the DOC forum for you.

You know you write great DOC's and How-To's and this will just be another one of those.  
 




____________
| Icy Phoenix ColorizeIt! |
Bipolar Disorder - Not good for you and definitely not good for everyone else.
 
ChaoticSend private messageVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Well! I think you and I agree on one thing, and that is:  The documentation should assume that the end reader knows "Nothing" about Icy Phoenix. And that's why IMHO - most of the current docs are too cryptic to be of much help to anyone, let alone the novice.
 
 
 
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I moved your new DOC to the Documentation And How To forum.

I remember us talking about DOC'S a while back and we agreed you should create every DOC with a novice mindset.  Dotting all the i's and crossing all the t's.

Great work!
 




____________
| Icy Phoenix ColorizeIt! |
Bipolar Disorder - Not good for you and definitely not good for everyone else.
 
ChaoticSend private messageVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Lopalong wrote: [View Post]
The documentation should assume that the end reader knows "Nothing" about Icy Phoenix.

I quote this.

Lopalong wrote: [View Post]
And that's why IMHO - most of the current docs are too cryptic to be of much help to anyone, let alone the novice.

The reason is simple... almost nobody in the past took care of docs section. Most of the contributions have been moved there after a problem solving in support forum...

As you know, I don't have the time and I can't speak perfect English either... I really need some good English speakers like you helping me in creating good docs.

Sometimes it's just a matter of wrapping up support topics, and I totally agree with you Lopalong, but we have to keep in mind that we are volunteers, and sometimes we don't have the time to create a good doc starting from a support topic... so that is the reason why I have moved so many support topics in the Docs section.

I have just chosen having something instead that nothing there... I hope you understand and agree on that.

Thanks for your contributions and feedbacks... you know... I appreciate.


 




____________
Luca
SEARCH is the quickest way to get support.
Icy Phoenix ColorizeIt - CustomIcy - HON
 
Mighty GorgonSend private messageSend e-mail to userVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Mighty Gorgon wrote: [View Post]
As you know, I don't have the time and I can't speak perfect English either... I really need some good English speakers like you helping me in creating good docs.


I'm a sucker for this!  

I've already started going through the "Old" docs I did and am slowly cleaning them up for IPv1.3*

I'm also adding v1.3 at the end of the title. It's not really necessary I would imagine, but at the moment it "Tags" what I've done and what I haven't; so I would appreciate it if that's left on the end of the title in the short term.

Then, I'm going to start having a look at few other things that could be "cleaned" up.  
 
 
 
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I have removed v1.3 from a couple of your docs... because I think that there is no need for that since it is the latest stable release.

But I'll leave that for now.

You should be able to edit your own posts there, isn't it? In case you need that prefix you can re-add that temporarily.
 




____________
Luca
SEARCH is the quickest way to get support.
Icy Phoenix ColorizeIt - CustomIcy - HON
 
Mighty GorgonSend private messageSend e-mail to userVisit poster's website  
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
I agree that the ver is not needed - but it was better than me adding "Finished this one" to the title!  

I'll remove the ver when I finish editing all of my own files (and that won't be too long) - because that makes it easier for me to keep track of what I've done.

You also now have some 1.27* stuff in there!  
 
 
 
Back to topPage bottom
Reply with quote Download Post 
Post Re: Improving Docs Section 
 
Yes, there is some old stuff which should still work but with some tweaks.

We will sort out everything...
 




____________
Luca
SEARCH is the quickest way to get support.
Icy Phoenix ColorizeIt - CustomIcy - HON
 
Mighty GorgonSend private messageSend e-mail to userVisit poster's website  
Back to topPage bottom
Post new topic  Reply to topic  Page 1 of 2
Goto page 1, 2  Next


Display posts from previous:    

HideWas this topic useful?

Link this topic
URL
BBCode
HTML




 
Permissions List
You cannot post new topics
You cannot reply to topics
You cannot edit your posts
You cannot delete your posts
You cannot vote in polls
You cannot attach files
You can download files
You cannot post calendar events


  

 

  cron