P key not working?Everah wrote:The easier to understand, the better. Even if there are different types of users, if you can reach the most comuter illiterate grou of users, everyone could feasibly stand a chance at understanding your. It is tough. I know. I have been writing user guides for some folks at work that I think my 5 year old daughter could read and understand.And even these can go over their heads sometimes.
But I think if you target the entry level users, and if you can get close to reaching them, your docs should be golden.
Documentation
Moderator: General Moderators
- Chris Corbyn
- Breakbeat Nuttzer
- Posts: 13098
- Joined: Wed Mar 24, 2004 7:57 am
- Location: Melbourne, Australia
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA
That is funnier than crap.
I was on my wife's computer this morning, and there are times when the keys just don't register. I guess this morning, it was P.
I suose I should roofread my osts before ressing the review or submit buttons, huh?
Doh, wait, I am on a computer that acutally has working components now. Silly me...
I was on my wife's computer this morning, and there are times when the keys just don't register. I guess this morning, it was P.
I suose I should roofread my osts before ressing the review or submit buttons, huh?
Doh, wait, I am on a computer that acutally has working components now. Silly me...
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA
- Chris Corbyn
- Breakbeat Nuttzer
- Posts: 13098
- Joined: Wed Mar 24, 2004 7:57 am
- Location: Melbourne, Australia
- RobertGonzalez
- Site Administrator
- Posts: 14293
- Joined: Tue Sep 09, 2003 6:04 pm
- Location: Fremont, CA, USA
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
Here's a tip...d11wtq wrote:Thanks to this thread I'm currently going through my my latest source code adding phpdoc comments. Oh dear, I think there's going to be almost as many, if not more lines of comments than there are lines of code by the time I'm done
Comment like crazy...but on anything more than a line or two use multi-line comments...
That way people who hate looking at zillions of comments can hide them by using an editor which supports source folding and/or recognizes /* */ as a code block...
UltraEdit does and I use it like mad because as much as I comment I also hate to look at what I already know
Cheers