Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me
You are here: Home / Career Development / SharePoint 2010 for technical writers

SharePoint 2010 for technical writers

July 6, 2012 by RDesprez 7 Comments

Tweet

When I first start­ed using Share­Point, I have to admit that I was not impressed.

The user inter­face felt unin­spired. Some soft­ware user inter­faces draw you in. For me, Share­Point was­n’t one of them. I remem­ber won­der­ing, “Why would I want to use this?”

I’ve changed my tune. After learn­ing more about Share­Point’s ben­e­fits and using it at sev­er­al client sites, I rec­og­nize that it offers a num­ber of ben­e­fits to tech­ni­cal writers:

* Share­Point pro­vides a basic Con­tent Man­age­ment Sys­tem (CMS). Peo­ple use a CMS to pub­lish, edit, and man­age con­tent, such as doc­u­ments. A full-blown CMS is expen­sive where­as Share­Point is fre­quent­ly already installed in larg­er orga­ni­za­tions. Tech­ni­cal writ­ers can use it to gain con­trol over their doc­u­ments at the file level.

* Share­Point Foun­da­tion 2010 is free. Share­Point 2010 is avail­able in two flavours: Share­Point Serv­er 2010 and Share­Point Foun­da­tion. Share­Point Serv­er offers more fea­tures than Share­Point Foun­da­tion but the lat­ter is free.

* You can use meta­da­ta to tag your files. If you are work­ing on a lot of con­tent, adding meta­da­ta to your files may be a worth­while invest­ment because it helps group your con­tent into cat­e­gories. Meta­da­ta is a col­lec­tion of cen­tral­ly man­aged terms that you can define and then use as attrib­ut­es for a file. Then, after you have tagged your con­tent, oth­er writ­ers can search for doc­u­ments using the same categories—content is eas­i­er to find and update.

* Source con­trol. Share­Point requires you to check out files before you edit them and offers ver­sion con­trol of the file. Ver­sion con­trol essen­tial­ly keeps a his­to­ry of the file. If for some rea­son you want to res­ur­rect an ear­li­er ver­sion of a doc­u­ment, Share­Point makes it easy.

* Col­lab­o­ra­tion. Share­Point enables teams to col­lab­o­rate on files. If you are work­ing with anoth­er per­son on a file, each writer can work on the con­tent con­cur­rent­ly and the lat­est ver­sion is then uploaded to the Share­Point site.

* Doc­u­ment con­trol. Share­Point makes it pos­si­ble to restrict users at the site lev­el. Best prac­tices sug­gest assign­ing employ­ees or con­trac­tors to user groups.

* Work­flows. In Share­Point, you can auto­mate the review process. As a writer, you can cre­ate a list of review­ers and add dead­lines. Share­Point then sends e‑mails to SMEs and sends you an e‑mail when they have reviewed the document.

* Trans­la­tion work­flows. If you need to trans­late your con­tent, Share­Point can assist with the process by remind­ing exter­nal stake­hold­ers to per­form tasks by cer­tain dates, and e‑mails you when all of the work is complete.

* Easy to use. Share­Point has a sim­i­lar look and feel to oth­er Microsoft Office prod­ucts. It sports the famil­iar Microsoft rib­bon and the tasks are pret­ty straight­for­ward (for tech­ni­cal writ­ers, at least).

* Lots of sup­port con­tent. There are many books, web sites, and blogs about Share­Point. For exam­ple, check out these online train­ing courses.

The bot­tom line: Share­Point is a worth­while tool if col­lab­o­ra­tion is impor­tant and you need con­trol over your source files. Sounds like a good fit for most tech­ni­cal writers.

Filed Under: Career Development, Online Collaboration, Robert Desprez | Vancouver technical writer | Blog, Technology, Web 2.0 Tagged With: benefits of SharePoint, technical writers

Comments

  1. Wayne Dale says

    July 11, 2012 at 3:38 pm

    Hi Robert,

    Your post is very time­ly because I have recent­ly sub­scribed to Microsoft Office365, giv­ing me com­plete access to cre­at­ing my own Share­Point 2010 site. I am now in the process of learn­ing how to use and apply it for my intend­ed purposes. 

    I had stud­ied Share­Point in the past and thought it was very pow­er­ful for cor­po­rate envi­ron­ments but, like you, won­dered what it real­ly had to offer me as an inde­pen­dent tech­ni­cal writer and what I need­ed to know about using it.

    Well, what I have learned to this point has been encour­ag­ing. How­ev­er, your infor­ma­tion has giv­en me enough insight into the total Share­Point “pack­age” that I’m glad I decid­ed to go down this road. I also plan to learn Share­Point Design­er which, from what I have read, should open up even more Share­Point func­tion­al­i­ty as I go forward. 

    Thanks

    Reply
  2. Mike Baron says

    July 12, 2012 at 12:59 pm

    Hi Robert,

    Enjoyed your arti­cle. We use Word­Press as a CMS. Agree with your com­ment that “(t)ech­ni­cal writ­ers can use (Share­Point) it to gain con­trol over their doc­u­ments at the file lev­el,” but I find WP a more effec­tive tool for com­mu­ni­cat­ing nar­ra­tive and workflow. 

    Would be inter­est­ed in com­par­ing notes with you. Thanks again for your article.

    Reply
  3. Robert Desprez says

    July 12, 2012 at 2:33 pm

    Hi Wayne,
    I’m glad you found my post time­ly! Thanks for your comment.

    Reply
  4. Robert Desprez says

    July 12, 2012 at 2:38 pm

    Hi Mike,
    Thanks for your feed­back. Sure, I’d be inter­est­ed in hear­ing how you use Word­Press to man­age your con­tent and how you use workflows.

    Reply
  5. Roger Douglas says

    July 12, 2012 at 3:18 pm

    Hel­lo Robert:
    I’m real­ly glad to read your descrip­tion about Share­Point as a CMS appli­ca­tion. Three years ago, I inter­viewed for a few posi­tions that were pri­mar­i­ly to start up a CMS site in the cor­po­rate envi­ron­ment. All of the inter­view­ers were aware of Share­Point, but did not think it was ade­quate for their needs at that time. Per­haps they were not aware of the capa­bil­i­ties you detailed, or the capa­bil­i­ties were not yet includ­ed in Share­Point. I end­ed up doing oth­er Tech Writer assign­ments, but have since won­dered about Share­Point as a CMS. Thanks for pro­vid­ing this information.

    Reply
  6. Bob Mitchell says

    July 12, 2012 at 4:21 pm

    Hi Riobert,

    I agree with your assess­ment of Share­Point. It’s good for a cor­po­rate envi­ron­ment. In the envi­ron­ment I am in, it is used by var­i­ous teams, etc. but did not know that it had CMS fuc­n­tion­al­i­ty. I’m going to inves­ti­gate that fur­ther. Thanks for your input/thoughts.

    Reply
  7. Matt Evans says

    July 12, 2012 at 4:30 pm

    Hi Robert,
    Nice arti­cle and have to say agree, but of course, I’m biased as a Writer for Microsoft Share­Point. Share­Point is great for man­ag­ing doc­u­ments, and worth­while from that stand­point alone. But it does a lot more than that, par­tic­u­lar­ly if you use Share­Point Serv­er. Even in the free Share­Point Foun­da­tion ver­sion, though, you can cre­ate blogs, wikis, dis­cus­sion boards, and use cre­ate lists to bring data into Share­Point and man­age it in one place, sim­i­lar to how you’d do in Excel. I’d like to clar­i­fy a cou­ple of details you men­tioned above. For source con­trol, Share­Point does­n’t require check­out of doc­u­ments, unless the own­er of the doc­u­ment library turns on required check­out. Ver­sion con­trol is anoth­er great option that the own­er has to turn on. Ver­sion con­trol and required check­out can be turned on sep­a­rate­ly, as well. For those out there look­ing for more info, please feel free to vis­it our web­site at sharepoint.microsoft.com/blogs/GetThePoint.

    Reply

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

About Robert Desprez

I have worked as a Vancouver technical writer for more than 20 years, working at some of British Columbia's largest high-tech firms. I have served in leadership positions for the Society for Technical Communication and have worked as a writing instructor at Vancouver's Simon Fraser University.

Robert Desprez Follow 1,147 239

Vancouver Technical Writer. Former Instructor at Simon Fraser University. Dog Lover. Coffee Drinker. Tennis and Piano Player.

robert_desprez
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413647243559161

Image for twitter card

I Regret My Tesla | The Walrus

I wanted to be good. Then the car company fell from grace

thewalrus.ca

Reply on Twitter 1923413647243559161 Retweet on Twitter 1923413647243559161 0 Like on Twitter 1923413647243559161 0 Twitter 1923413647243559161
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413050498957392

Image for twitter card

Brian Chesky Lost His Mind One Night—and Now He's Relaunching Airbnb as an Everything App

Airbnb's CEO is spending hundreds of millions to relaunch his travel company as an all-purpose service app. Fitness!...

www.wired.com

Reply on Twitter 1923413050498957392 Retweet on Twitter 1923413050498957392 0 Like on Twitter 1923413050498957392 0 Twitter 1923413050498957392
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923412665478627824

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister /via @globeandmail

Image for twitter card

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister

Experts say Solomon could face a host of challenges in his role, including how to increase AI adoption and comme...

www.theglobeandmail.com

Reply on Twitter 1923412665478627824 Retweet on Twitter 1923412665478627824 0 Like on Twitter 1923412665478627824 0 Twitter 1923412665478627824
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 May 1918126029463536113

This productivity poison is exhausting you /via @globeandmail

Image for twitter card

This productivity poison is exhausting you

Constantly shifting your attention undermines what is your super power in most knowledge jobs. How you anticipate an...

www.theglobeandmail.com

Reply on Twitter 1918126029463536113 Retweet on Twitter 1918126029463536113 0 Like on Twitter 1918126029463536113 0 Twitter 1918126029463536113
Load More

Recent Blog Posts

  • ChatGPT: The AI-Powered Proofreader
  • Four Ways Confluence Could Be Better
  • First impressions of MadCap’s purchase of IXIASOFT
  • Online Conferences for Technical Writers in 2023

About Me

Robert Desprez I have worked as a Vancouver technical writer for more than 20 years, working at Kodak, Boeing, Teck Resources, and FortisBC. In addition, I have worked as a writing instructor at Simon Fraser University in Vancouver.

Contact Me

Robert Desprez Com­mu­ni­ca­tions Inc.
North Van­cou­ver, British Columbia
Canada
Phone: 604–836-4290

  • Email
  • LinkedIn
  • Twitter

Copyright © 2025  · Robert Desprez Communications Inc.