Ce cours vous offrira de nombreuses opportunités de pratiquer l’art de la rédaction de dissertation technique. Voici quelques directives simples que vous pouvez utiliser pour éviter les problèmes courants.
Nommez le fichier de rédaction en fonction de son sujet (et non de sa date).
Les fichiers d’essai de modèle techfolio sont nommés avec la date à laquelle ils ont été créés (c’est-à-dire 2015-08-26.md ). Ne faites pas cela: nommez chaque fichier de dissertation pour refléter son sujet. Par exemple, vous pouvez baser le nom du fichier sur le titre de votre essai. Si le titre de votre essai est « Allumer le feu », votre nom de fichier peut être « igniting-the-fire.md « .
N’incluez pas d’espaces dans le nom du fichier : utilisez « igniting-the-fire.md « , pas » allumant le fire.md « .
Si le navigateur télécharge le fichier au lieu de l’afficher, c’est probablement parce que le nom du fichier ne se termine pas par « .md ».
Une dénomination correcte est importante pour que l’URL associée à votre essai soit facile à lire et donne une indication de son sujet.
N’utilisez jamais « reflect » ou « reflections » dans le nom de votre fichier.
Créez un titre intéressant qui attire le lecteur.
Ne nommez pas votre essai avec le nom du module (c’est-à-dire « Gestion de la configuration ») ou le nom de l’expérience (c’est-à-dire « Réflexions sur Javascript »). Les moteurs de recherche mettent souvent l’accent sur le titre des pages. Voulez-vous lire un essai basé sur un titre comme celui-là? Avec un peu de réflexion, vous pouvez trouver quelque chose de personnel (c’est-à-dire « La catastrophe de la gestion de la configuration qui m’a presque coûté mon travail ») ou d’intelligent (« Vous ne pouvez pas toujours git ce que vous voulez »).
N’utilisez jamais « reflect » ou « reflections » dans votre titre.
Utiliser l’orthographe et la grammaire appropriées
Ne pas mal orthographier les mots. Utilisez une grammaire appropriée. Si vous n’êtes pas confiant, utilisez des outils en ligne pour vérifier l’orthographe et la grammaire avant la publication.
Écrivez pour le monde, pas pour le professeur
Bien que beaucoup de vos essais seront basés sur vos expériences de devoirs à domicile (c’est-à-dire des expériences), n’écrivez pas votre essai comme s’il s’agissait d’un e-mail privé au professeur expliquant le devoir. Ne créez pas de sections pour répondre à chacune des « questions » de l’invite. Si vous faites cela, vous créerez presque certainement un essai ennuyeux qui n’est pas intéressant à lire.
Au lieu de cela, écrivez-le « pour le monde ». Supposons qu’un professionnel technique aléatoire ait googlé et que votre essai soit apparu. Rendez l’essai autonome, explicite et utile à ce professionnel aléatoire. Minimisez les hypothèses que vous faites sur les antécédents en génie logiciel de cette personne (et encore moins leur expérience dans cette classe!) Fournir des liens vers des documents d’information s’ils sont utiles.
Non seulement vous devriez l’écrire pour une variété de personnes, mais vous devriez l’écrire pour une variété de fois. En d’autres termes, essayez d’écrire votre essai de telle sorte que si quelqu’un le lit dans un an, il fournira toujours des informations de valeur. Si vous êtes un débutant sur le sujet, écrivez-le pour donner un aperçu et une compréhension aux autres débutants.
Pour rendre un essai convaincant, il est généralement utile de « raconter une histoire ». Créez un récit, ne vous contentez pas de répondre aux questions.
Formatez correctement le code
Assurez-vous que le code s’affiche correctement dans votre publication. Pour ce faire, utilisez des blocs de code clôturés et une coloration syntaxique. Voici un exemple de mise en évidence du code javascript :
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}Réfléchissez bien avant d’inclure de gros extraits de code (au-delà, disons 50 lignes). En règle générale, gardez les extraits de code à une longueur raisonnable et assurez-vous que tout le code est directement lié au sujet de votre essai.
Utilisez des en-têtes internes pour structurer votre essai
Les bons essais ont une sorte de structure interne. Aidez le lecteur à comprendre cette structure en fournissant des titres internes. Ne commencez pas par H1 (c’est-à-dire # dans Markdown), car cela est réservé au titre de votre publication. Au lieu de cela, commencez par H2 (## dans markdown), puis créez des sous-sections dans cette section avec H3 (### dans markdown), etc.
De même, utilisez des listes détaillées ou énumérées, des tableaux, etc. selon le cas.
Citations de format et d’attribut
Vous voudrez parfois citer un autre auteur dans vos essais techniques. C’est bien tant que vous ne présentez pas ces mots comme les vôtres.
Si vous ne citez qu’une seule phrase ou deux, vous pouvez simplement utiliser des italiques, des guillemets et indiquer le nom de l’auteur. Par exemple:
Comme l’a noté Steve Jobs, « Le design n’est pas seulement ce à quoi il ressemble et se sent. Le design, c’est comment ça marche. »
Pour des guillemets plus longs, utilisez l’environnement <blockquote > avec le pied de page < >. Par exemple:
Un jeune cynique est presque le spectacle le plus triste à voir, car cela signifie qu’il est passé de ne rien savoir à ne rien croire.
Incluez des images ou d’autres supports
Comme on dit: « Une image vaut mille mots. »Il est très facile d’inclure des photos et des vidéos dans vos essais. Si le sens de votre essai sera communiqué plus clairement avec des images, prenez le temps de les trouver et de les inclure. Reportez-vous à la section Mise en forme du Guide de l’utilisateur TechFolio pour obtenir des instructions sur la façon d’inclure des images et des vidéos.
Ne soyez pas ennuyeux, ne soyez pas inapproprié
Juste parce que l’essai est de nature technique, il n’a pas besoin d’être ennuyeux. Essayez d’injecter votre personnalité dans votre écriture. Vous pouvez avoir des titres « intelligents », des références à la culture pop, etc.
D’autre part, n’allez pas trop loin sur l’intelligence. Demandez-vous: serais-je gêné si ma mère lisait cet essai? (Parce qu’elle pourrait.) Serais-je gêné si un employeur potentiel lisait cet essai? (Parce qu’elle pourrait.)
L’objectif est d’être créatif, de montrer de la personnalité et de rendre l’essai amusant à lire et informatif.
Ne l’écrivez pas à la dernière minute
La qualité de vos essais augmentera considérablement si vous les développez comme suit:
- Écrivez le premier brouillon.
- Faites autre chose pendant 4 heures.
- Revenez et faites une passe d’édition sur le premier brouillon.
La passe d’édition attrapera normalement beaucoup de problèmes et vous permettra d’affiner vos pensées de manière significative, tant que vous vous êtes éloigné de l’essai pendant suffisamment de temps pour vous permettre de le voir avec des « yeux frais ». La meilleure façon de le faire est de dormir dessus pendant la nuit, mais si vous n’avez pas beaucoup de temps, faites au moins quelque chose de différent pendant quelques heures. Cela permet à votre subconscient d’aller travailler sur le matériau.
Examinez le contenu et l’apparence de votre message
Une fois que vous l’avez écrit et publié, récupérez-le dans un navigateur et voyez à quoi il ressemble.
Un paragraphe ne suffit pas
Écrire un essai de deux ou trois phrases dans l’espoir d’obtenir un crédit partiel n’est pas une bonne stratégie. D’une part, un tel essai reflète plus mal votre personnalité professionnelle qu’aucun essai du tout. Pour une autre chose, nous avons tendance à attribuer zéro point pour les essais qui reflètent très peu d’effort.
Utilisez le Centre d’écriture UH Manoa
Le Centre d’écriture UHM fournit des consultants formés pour vous aider à toutes les étapes du processus d’écriture; que vous commenciez à commencer, que vous révisiez un brouillon ou à un moment donné entre les deux.
Vous pouvez planifier jusqu’à deux rendez-vous par semaine ainsi que trois rendez-vous sans rendez-vous par semaine.