Code of Ethics
The proposal below is a draft based on a round of comments that took place offline. So far technical writers in Israel are divided on the need for a formal code of ethics, but this may change if the proposed code is improved upon. In the meantime elephant.org.il has adopted its own Code of Ethics.
Another issue that has both ethical and legal implications is the use and content of Non-Competition Agreements for technical writers.
Please read and comment. When adding a comment, make sure to click Preview then Save.
Proposal for Discussion
As a technical writer and member of the Yokneam Forum, I agree to observe the highest ethical and professional conduct and agree to:
1. Accept responsibility for my work.
2. Protect the Intellectual Property of my employers and clients to the best of my ability.
3. Avoid real or perceived conflicts of interest whenever possible, and to disclose them to affected parties when they do exist.
4. Credit properly the contributions of others.
5. Honor agreements, both written and verbal to the best of my ability.
6. Maintain and improve my technical competence.
7. Undertake documentation tasks only if qualified by training or experience, or after full disclosure of pertinent limitations.
8. Seek, accept, and offer honest criticism of technical work and documentation.
9. Acknowledge and correct errors.
10. Treat fairly all persons regardless of irrelevant factors such as race, religion, gender, disability, age, or national origin.
11. Avoid injuring others, their property, reputation, or employment by false or malicious action.
12. Assist colleagues and co-workers in their professional development and to support them in following this code of ethics.
Related Issues
Non-Competition Agreements for Technical Writers
Cutting a Contract Short - discussion on Techwr-l Start of thread...
Are you on the elephant.org.il Mailing List?
You can add yourself directly to the mailing list for announcements using the In-house TW subscription link or Contractor/Subcontractor TW subscription link.


For Hire Now!
Summaries




Upcoming Events
Item 10 is a basic tenant of our existance as Human beings, not Technical Writers.
A moral code for technical writers should direct the professional aspects dealing with the profession.
When a code looses focus, it loses relevance.
Item 11 comes close to the same problem, though at least it is work related.
I would remove both 10 and 11 as being non specific to the environment in which technical writers work.
I have to be honest and say I was thinking of joining the Yokneam writer's forum until I saw this. I see a number of problems both on a philosophical level, and with the actual content:
a)I'm not sure it is the responsibility of an informal forum to put together a code of ethics. Do you expect members to sign it as a prerequisite for membership?
b)What is the aim of such a code? If you can't measure its effect, what is the point in doing it? How can you check the integrity of a person signing it, or the perceived ongoing influence of such a code? What do you intend to do if it becomes obvious that someone has broken one of the codes for conduct?
c)There is a mismatch of items that I would expect to find in an employer/employee contract, together with a loose attempt at promises of professional standards, with a few sentences about moral conduct and respect for diversity thrown in for good measure.
d)The list is full of subjective descriptions to which no metrics can be applied, particularly when the subject is the person that signs it. What is "the highest ethical and professional conduct". Who can measure such a thing objectively?. What's the difference between a "real" conflict and a "perceived" one? How can we ensure that someone only works on a task if "qualified by training or experience"? I for one often try to work on stretch tasks that lead me to new places - that's how I improve professionally. Such documents require a very careful wording - avoiding general "marketing" type statements.
There are a lot more issues, but I'll leave it there. I would prefer to see such a code try to capture the essence of such a forum. For example - how each member is expected to contribute to the forum, guidelines for mutual support, an agreement of how members would like to see the forum grow and develop.
I really don't think a code of ethics is necessary; nonetheless, I have tried my hand at drafting a few priniciples of behavior based somewhat on the code of ethics.
Principles for Members of the Yokneam Forum for Technical Communicators:
As a member of the Yokneam Forum and as a member of the technical communications community, I accept the following principles as a way to advance myself personally, and to advance the field of technical communications generally:
1. I will strive to provide work at a high degree of professionalism in order to bring honor to myself and to my profession.
2. I will follow changes in technology in order to maintain my technical competence.
3. I will disclose my limitations when pertinent.
4. I will seek, accept, and offer honest criticism of technical work.
5. I will properly credit the contributions of others.
6. I will assist colleagues and co-workers in their professional development (within the constraints of my workload).
Why did people feel the need for such a code of ethics. Did you find a lot of people "behaving badly"?
At any rate
I was wondering how you thought of implementing:
"I will properly credit the contributions of others."
I can see myself doing this on a technical writing list, telling people that my comment was not my own idea, but in writing? I do not even get credit for my own writing!
Acting upon the suggestion of Svi Ben-Elya, I am reposting here my comments on the "Ethical Code" that I orginally posted on the Techshoret List.
What is the rationale behind the code? I don't think technical writing is amongst the most corrupt professions in the State of Israel that we need to formally accept such a code - if that is your idea. There are many other areas of Israeli life that would benefit from such a code of ethics, but I will resist the temptation to go OT and digress into this area.
I feel that the nature of the market should be sufficient to exclude the kind of behaviour you are seeking to guard against. I have not met any writers who do not feel a responsibility to give the users as clear and accurate explanations as possible.
As for specific comments, your point " Undertake documentation tasks only if qualified by training or experience, or after full disclosure of pertinent limitations" is superfluous. To give an extreme example, I don't imagine anyone on this List would agree to document a procedure at Israel's nuclear reactor if they lacked understanding of the nuclear energy industry. On the other hand, we are frequently asked to document new applications without any prior introduction. Part of the job often involves trying out the application and seeing by trial and error, how it works and how it is meant to work. Obviously the same approach, cannot (and should not!) be tried with nuclear energy. Are you suggesting writers should say to the project managers "Sorry, can't document the XYZ till testing is completed and I have had a full training course." In my experience the business does not operate in this manner. Part of the challenge of technical writing is "going where no writer has ever been before - or at least no writer with a basic command of English!"
If you remain set on drawing up a code of ethics for TWs, let me suggest a few clauses that I think you ought to include:
1. I will take the lunch break that I am provided by law as I recognise it benefits my health and improves my working capabilities. For the same reason, I will use all the vacation days given to me.
2. I accept the application of Thomas Malthus's "Law of Diminishing Returns" to the world of techncial writing and therefore, I will not work 15 hours days whatever the deadlines. I recognise the quality of my work suffers when I behave in such a foolish way and I believe that my emotional and physical wellbeing, and the welfare of my family have to take first place.
Regards,
Shimon
Shimon Frais
Senior Technical Writer
WritePoint
Svi Ben-Elya suggested I post my comment here (i orginally wrote privately to him in response to his post on the Techshoret List).
It's a nice thought and certainly there are many organizations with codes of ethics.
But I've always thought that people are either ethical or they aren't.
If someone needs to sign that list in order to follow those basic tenets, I wouldn't want to work with them to begin with.
Don't need to sign a code of ethics to respect myself, my work, and my colleagues.
TW is not medicine - we don't need a Hippocratic Oath to remind us of our responsibilities.
This CoE is irrelevant and redundant.
What this code of ethics is missing is about the *content* of what is written about. For example, isn't the omission of documentation about a known software bug considered unethical?
This what the code of ethics could contain. We're not talking about ethical human behavior, or even ethical business behavior. What about ethical *writing* behavior? Honesty? Comprehensiveness? Attitude? Fair representation?
Let's be honest with ourselves - Israel and Israelis are not known for their high ethical or business standards. This is my experience having worked in three different countries. I cannot see what harm having a CoE can do, so I'm for anything that might improve the situation, even if it's only a maybe.
Methinks the lady doth protest too much!
Hi Svi -
Sounds nice ...
But what is the point ?
We can use the Boy Scouts Oath equally well.
"to accept responsibility for my work"
What does it mean ? In practice ? How could one NOT take responsibility ? Consider the case in which I write something - how can I possibly NOT be responsble ?! Or consider the case in which one is given incorrect or incomplete information . Does the forum member take 100% responsibility here as well?
Does the taking of responsibility mandate Hara Kiri / Seppuku or incarceration ?
If the latter - how long, what conditions ?
Do we act as do the politicians and say (albeit rarely) "I take full responsibility" and then go on as normal ?
WHAT DOES IT MEAN ??
"to reject bribery in all its forms;"
Even in areas unrelated to tech writing ?!?!
Such Watch ??
"to improve the understanding of technology, its appropriate application, and potential consequences"
Do I now have to go on a world-wide quest every N years to spead the gospel about nuclear energy (or maybe the nuclear energy potential for distaster - WHICH?!), food additives, hydrogen motors, the dangers/ benefits of western medicine ??
Bribery for example, is a felony. All people present in Israel are forbidden by law to engage in bribery. Why limit tech writers to obeying this particular law? Are we to understand thereby that as tech writers we are free to engage in felonious acts *other* than bribery ?
You get the idea ....
It all sounds nice but has little quantified meaning.
Can one not be a member in good standing simply by not being convicted ?
Even there - can a reformed convict never become a tech writer in good standing?
Once convicted (even falsely) - never to write again ?!
Think of the potential loss to humanity !
;--))
Svi,
I very strongly oppose this move toward making a code of ethics part of belonging to the yokneam group, and it is not because I can find anything wrong with any of the ideas presented. But:
1) Such a code will always leave something out. There is nothing here about the environment, sexual harassment, family values, Israel, etc. The list could go on.
2) The kind of characters who might act in such unscrupulous ways would probably have no compunctions about signing all sorts of codes.
3) The law of natural consequences works, let's not try to push the river.
Larry
A guest wrote, "Item 10 is a basic tenant of our existance as Human beings,"
But I was wondering who the landlord might be.
Sounds like a good business move for all of us.
It gives the Elephant card added value. This is based on the assumption that if a card-carrying TW violates the code, the membership of that TW will be suspended.
What's the problem?