LinuxQuestions.org
Share your knowledge at the LQ Wiki.
Go Back   LinuxQuestions.org > Articles
User Name
Password

Notices

By XavierP at 2005-12-11 16:22
At the right hand side of the screen, there is a box which reads
Quote:
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
We do honestly want original content from you, the members of LQ. (We also like the Linux news links so keep them coming too).

So what does this have to do with you? Well, at the bottom of this post there is a link to email me. If you have an idea for an original article, put together a very brief summary of it and email me. I will then make contact with you and we can work together on making your idea into an article. I will be acting editorially, by the way, and won't be looking for a credit ;)

Articles can be on almost anything - read through the ones we have already and see if there is something you have been thinking of that would fit here.

Get writing!

by XavierP on Sat, 2006-02-18 16:10
For anyone who is interested in writing an article, please read this LXer page: http://lxer.com/module/newswire/view/54348/index.html

It will hopefully help you when you come to put your own articles together.

by SaintDanBert on Tue, 2011-02-22 20:23
As I read the site, many of the Articles and Tutorials are quite olde -- not only in calendar time, but also in terms of the content vs. the distro edition and components. The "topic" itself probably remains germaine, but the details are often written for kernels versions and package versions that may as well be ancient.

~~~ 0;-Dan

by onebuck on Wed, 2011-02-23 11:26
Hi,

I agree! But the only way things will be renewed or updated is by LQ member participation. Choose something and contribute a updated/revised article.

Most active LQ members are aware of the situation but to correct things someone needs to take the first step(s).
I would but too much on my platter/TODO list at this point in time.

Go for it!

by SaintDanBert on Wed, 2011-02-23 14:16
Quote:
Originally Posted by onebuck View Post
Hi,
I agree! But the only way things will be renewed or updated is by LQ member participation. Choose something and contribute a updated/revised article.
...
I do a pretty decent job of technical and end-user document writing, but I must have the information to work from. I can read code [grading C/C++ and scripting assignments] when I must but that becomes tedious work very quickly.

I've made inquiries at several projects and linux docs project and get a similar story every time I ask.
  • The developers know the details.
  • The details evolve at internet speed and get captured as code instead of documents.
  • Developers focus on code -- whether creating or maintaining -- instead of documents.
  • Developer time cannot then be used to provide raw details to writers.

If someone on LQ has clues how to proceed, please let me know what those are.
~~~ 0;-Dan

by onebuck on Wed, 2011-02-23 15:00
Hi,

Quote:
Originally Posted by SaintDanBert View Post
I do a pretty decent job of technical and end-user document writing, but I must have the information to work from. I can read code [grading C/C++ and scripting assignments] when I must but that becomes tedious work very quickly.

I've made inquiries at several projects and linux docs project and get a similar story every time I ask.
  • The developers know the details.
  • The details evolve at internet speed and get captured as code instead of documents.
  • Developers focus on code -- whether creating or maintaining -- instead of documents.
  • Developer time cannot then be used to provide raw details to writers.

If someone on LQ has clues how to proceed, please let me know what those are.
~~~ 0;-Dan
If you have done any third party technical documentation then you would understand that developers/maintainers are not proficient in communication outside their expertise.

To put it plainly, tech speak is one thing while general technical writing is a composition to interpret for the reader to understand the underlining information presented by the application author. Sometimes you must pull the information from the developer while at other times you will need to perform interpretations of their intent or even a single description of the operation as you see it. And hopefully you and the developer end up agreeing on your presentation. Interaction is important! But not always necessary if you have the skills to perform the desired task(s).

If you happen to be wrong then your interaction with other skilled writers will facilitate so as to provide a good/useful document. You could get lucky and have a developer who will share all documentation/notes for the application thus making things easier. I would not count on that since most programmers will not share their toolbox/notes unless $$ are involved.

by SaintDanBert on Wed, 2011-02-23 15:57
Quote:
Originally Posted by onebuck View Post
If you have done any third party technical documentation then you would understand that developers/maintainers are not proficient in communication outside their expertise.

To put it plainly, tech speak is one thing while general technical writing is a composition to interpret for the reader to understand the underlining information presented by the application author.
I've spent enough time in the developer trench to understand tech speak.
I've spent enough time in new-customer presentations and training to translate from tech to human pretty well.
Quote:
Sometimes you must pull the information from the developer while at other times you will need to perform interpretations of their intent or even a single description of the operation as you see it. And hopefully you and the developer end up agreeing on your presentation. Interaction is important! But not always necessary if you have the skills to perform the desired task(s).
My original point is that access to developers, for linux topics, borders on not possible for the reasons I cited.

Interaction IS important!! Where skills are concerned, code reading seems to be the only one that works because other details may exists, but are similarly hard to find.

Cheers,
~~~ 0;-Dan

by towheedm on Thu, 2011-09-08 23:22
Quote:
Most active LQ members are aware of the situation but to correct things someone needs to take the first step(s).
I would but too much on my platter/TODO list at this point in time.
This is the problem most times with people who write articles and documentations. They move on to other projects while the previous projects get some major changes but no one goes back to the original article to update it. I am guilty of this in one instance.

Quote:
I've made inquiries at several projects and linux docs project and get a similar story every time I ask.
  • The developers know the details.
  • The details evolve at internet speed and get captured as code instead of documents.
  • Developers focus on code -- whether creating or maintaining -- instead of documents.
  • Developer time cannot then be used to provide raw details to writers.
This is one of the thing badly lacking in linux apps. Proper documentaion, even a simple help file. In most instances, either the devs do not care to, or simple do not have the time to produce proper documentation even when someone else is willing to do the bulk of the work for them. They are the ones who develop the apps, and they are the only ones who know how to get things done.

As a very simple example, a someone develops a word processing app. A very basic feature might be on how to underline selected characters, words or even whole paragraphs. The dev is the only one who can say, "To underline a word, select the word, and press Ctrl-U or go the formatting toolbar and press the button with the underlined characters on it." For someone new to word processors, this may not be as simple a task as it sounds.

When it comes to even more complex tasks such as writing macros, the devs are the only ones who can help the documenter with this.

Quote:
Interaction IS important!! Where skills are concerned, code reading seems to be the only one that works because other details may exists, but are similarly hard to find.
I switched to Linux in Dec 2009. In April 2010, I produced my first tutorial on 'Customizng the Graphics in GRUB, XSplash GDM and Usplash'. This is what I'm not guilty of updating. Later on I produced my second tutorial on 'Theming GRUB2'. The second edition was released in May this year (the link is in my sig for those interested).

For this I really needed to dig deep into the gfxmenu code, because so much had changed within that year. Not being too conversant with C, it was no easy task. I put every spare moment for almost four months into that, and of course the devs were of no help.

I can only imagine the horror of having to dig deep into the source code of a much larger program to document it. It really is next to impossible without the help of the devs. If only someone can get them to understand this.

by johntaw on Wed, 2012-02-15 05:01
I have created a presentation with very easy step by step follow through pictures on how to install Ubuntu on Oracles VM Virtual box. The presentation requires no preinstalled software, all is included in the presentation. The goal is to make a 'real installation' rather then the Live mode.
It's in Swedish on one of my sites:

http://www.linuxdist.se/wp-content/u.../12/ubuntu.pdf

by Ztcoracat on Mon, 2013-01-28 15:21
Hi:

I've spent the better part of 4 weeks helping a member trouble shoot his printer.

One other Senior member joined the thread and an additional member joined as well.

Long story short; after much laboring and trouble shooting (on my behalf and others) I think it would be an asset to our group if I write a specific article addressing this Brother Printer issue and the steps advised that lead to a solved resolution.

I propose all of the ample information, links, commands and arguments to libraries that resulted in success to a printer that finally lead to complete functionality.

I'll gladly e-mail Xavier our Moderator the article but I figured it would be good to post of this first before investing time to compose the article; this would be the first paper I have written.

I thoroughly read the instructional page for "Writing An Article" the Heading, Lead and Conclusion is clear.

Where would I check to see that this subject has not been published already?

by jeuxdemoto12 on Tue, 2013-10-29 04:39
Sometimes you must pull the information from the developer while at other times you will need to perform interpretations of their intent or even.........................


  



All times are GMT -5. The time now is 06:48 AM.

Main Menu
Advertisement

My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
identi.ca: @linuxquestions
Facebook: linuxquestions Google+: linuxquestions
Open Source Consulting | Domain Registration