TECH |
Engadget Japanese |
手裏剣で妖怪退治!敵弾多めの縦シューティング『般若弾幕伝』:発掘!スマホゲーム |
https://japanese.engadget.com/hannya-danmakuden-211007129.html
|
退治 |
2022-01-09 21:10:07 |
IT |
ITmedia 総合記事一覧 |
[ITmedia News] Meta(旧Facebook)、新たな「プライバシーセンター」でユーザーを“教育” |
https://www.itmedia.co.jp/news/articles/2201/10/news028.html
|
facebook |
2022-01-10 06:28:00 |
Google |
カグア!Google Analytics 活用塾:事例や使い方 |
「鍵かけたっけ?」を防止できる!便利グッズ紹介系インフルエンサーにおすすめしたいかけ忘れ防止アイテム3選 |
https://www.kagua.biz/review/kaden/20220110b1.html
|
便利グッズ |
2022-01-09 21:00:24 |
python |
Pythonタグが付けられた新着投稿 - Qiita |
【図解】ROC曲線の意味と描画方法についてイメージをつかむ |
https://qiita.com/ToppaD/items/53a44089cdcbbff586ad
|
全てのデータを陰性と判定してしまうような意味のない分類器によって分類を行ったとき、混同行列は以下の通りになります。 |
2022-01-10 06:58:51 |
python |
Pythonタグが付けられた新着投稿 - Qiita |
【微小領域環】直交座標系(Cartesian Coordinates System)や極座標系(Polar Coordinates System)との対応。 |
https://qiita.com/ochimusha01/items/b96c0086f6f4fef93406
|
この時、Z軸には円錐座標系の場合にも、球面座標系の場合にも、次元球体Mが射影される。 |
2022-01-10 06:47:33 |
python |
Pythonタグが付けられた新着投稿 - Qiita |
DenoであらゆるPythonライブラリが使えるようになったらしいので試す |
https://qiita.com/access3151fq/items/a26c267fffaaea287269
|
日本語が含まれているとコードの一部が欠けた状態で実行されることがあるようで、奇妙なエラーが発生します。 |
2022-01-10 06:16:05 |
js |
JavaScriptタグが付けられた新着投稿 - Qiita |
DenoであらゆるPythonライブラリが使えるようになったらしいので試す |
https://qiita.com/access3151fq/items/a26c267fffaaea287269
|
日本語が含まれているとコードの一部が欠けた状態で実行されることがあるようで、奇妙なエラーが発生します。 |
2022-01-10 06:16:05 |
Program |
[全てのタグ]の新着質問一覧|teratail(テラテイル) |
linux とSSH接続について |
https://teratail.com/questions/377396?rss=all
|
|
2022-01-10 06:15:08 |
海外TECH |
MakeUseOf |
What Is Phantom Wallet? How to Use DeFi & NFTs on Solana |
https://www.makeuseof.com/what-is-phantom-wallet-use-defi-nfts-solana/
|
process |
2022-01-09 21:16:43 |
海外TECH |
DEV Community |
How to Create a Style Guide as a Technical Writer |
https://dev.to/wonexo/how-to-create-a-style-guide-as-a-technical-writer-317b
|
How to Create a Style Guide as a Technical Writer IntroductionHaving a style guide is a very useful way of having a clear and consistent form of writing that can be improved over time This guide is mostly useful for technical writers I ll be sharing a few things I learned so far writing for an open source community Fastify There are a few things you need to know and consider when writing your style guide Why am I writing this Even though it is necessary to have a style guide knowing why can help you figure what needs documenting Speaking with your community members developers or a lead Could be a program project manager or a developer advocate if there is one can help you identify your organisation needs Who am I writing this for Perhaps you want a style guide for open source community members who contribute to existing documentations or intended for developers who write API documentation and requirements Describing what the Guide focuses on helps the reader identify which style guide to follow You can save them the time of reading through the whole thing before they realise it even some may not figure it out eventually Do make sure you include a clear description of the guide What should I consider when writing one There is a lot to consider when writing a style guide here are lists of things you may need to include in yours Guide requirementsA guide requirement tells the reader what they need to know before writing specific documentations Take this example A user finds an open source project built with React Javascript framework they want to contribute to on Github but does not know the requirements needed In this case you can provide a requirement in a style guide that notes their need to understand specific tools and programming languages like Javascript HTML CSS and may also need to be familiar with Markdown FontsYour fonts determine the quality and standards of your documentation According to Uwe R Zimmer good typesetting is the technical skill that enables your reader to take in your material smoothly fast and efficiently Knowing when to use bold and emphasis what font size to use and how much line space is needed encourages better readability for your readers and improve the content design in general If you want to know more about font selection check out the Basic Rules of Using Fonts Properly in a Technical Document by Ugur Akinci on medium Visual contentSome documentation doesn t require images Most documentation tends to avoid Images to optimise storage and avoid the need to keep changing them when updates come up It s okay to include them in product guides or documents that depend upon Images for a better description You can also refer to an Image Video linked separately Youtube Cloudinary Vimeo which you can update without directly altering the docs Writing styleIncluding a writing style can help your reader know what type of document should be formal or informal In my case I find docs like references terms amp conditions in a formal tone while guides tutorials and articles use a more friendly approach Identify what writing style is needed before you conclude on which to employ Condescending termsCondescending words give off a feeling of superiority to your readers Using condescending tones are very sensitive Words like obviously him he simply or master are forms of condescending terms that can affect users who are not so confident or knowledgable about a particular topic You might tend to lose them along the way It s not a good reputation to let any of your readers feel like they are too dumb to understand or feel it s not for them You can include a list of words to avoid in your guide example Use Primary not Master Use They not Him To get more insight you can read an article by Carolyn Stransky How to remove condescending language from the documentation Use of verbsVerbs play a vital role in making the reader take action and to take action I mean to start your sentence with a verb Highlighting when and how these verbs are applied can help improve the documentation especially when it requires the user to take action This approach is widely adopted in how to guides because it requires the user to follow specific instructions Here s an example of where this can be used and compared to a less effective one Example Plain To install all dependencies you need to type in npm install in your terminal Use of verb Open your terminal and type in npm install to install all dependencies Plain There is a need to delete the folder called Back up so that the hard drive space can be saved Use of verb Delete the folder name Back up to save hard drive space Code indentationIf your documentation might entail some form of code examples providing a standard indentation style is essential to keep your code structured neat and consistent There are three indentation styles I know of Two spacesFour spacesTabsDevelopers have been debating on which indentation is best Spaces always take the win due to PSR standards If your team already have a standard they follow then you can include that in your guide There are many more things to consider This guide will put you on the right track I hope this gives you some direction to making the most effective style guide for your team Here are also some pointers that can help Gatsby style guideGoogle developer documentation style guideWrite the docsApple style guideMicrosoft writing style guideIf you find this article helpful a like from you will be awesome It ll help push this article forward to those who might need this Happy writing and cheers |
2022-01-09 21:29:56 |
ニュース |
BBC News - Home |
New York fire: At least 19 killed in apartment block blaze |
https://www.bbc.co.uk/news/world-us-canada-59931896?at_medium=RSS&at_campaign=KARANGA
|
bronx |
2022-01-09 21:45:23 |
ビジネス |
東洋経済オンライン |
爆売れ軽バンの実力!ホンダ「N-VAN」買ってみた 仕事やプライベート、趣味のバイク遊びを満喫 | 軽自動車 | 東洋経済オンライン |
https://toyokeizai.net/articles/-/478215?utm_source=rss&utm_medium=http&utm_campaign=link_back
|
東洋経済オンライン |
2022-01-10 06:30:00 |
コメント
コメントを投稿